📝 Add Synopsis chapter.
This commit is contained in:
parent
5933947000
commit
5c55b9412f
3 changed files with 61 additions and 16 deletions
45
docs/api/synopsis.md
Normal file
45
docs/api/synopsis.md
Normal file
|
@ -0,0 +1,45 @@
|
|||
# Synopsis
|
||||
|
||||
All [node.js's built-in modules](http://nodejs.org/api/) are available in
|
||||
atom-shell, and third-party node modules are fully supported too (including the
|
||||
[native modules](../tutorial/use-native-node-modules.md)).
|
||||
|
||||
And atom-shell also provided some extra built-in modules for developing native
|
||||
desktop applications, some modules are only available on browser side, and some
|
||||
are only available on renderer side, and some can be used by both sides. The
|
||||
basic rule is: if a module is GUI or low level system related, then it should
|
||||
be only available on browser side. You need to be familiar with the concept of
|
||||
[browser side](../tutorial/quick-start.md#the-browser-side) to be able to use
|
||||
those modules.
|
||||
|
||||
The browser side script is just like a normal `node.js` script:
|
||||
|
||||
```javascript
|
||||
var app = require('app');
|
||||
var BrowserWindow = require('browser-window');
|
||||
|
||||
var window = null;
|
||||
|
||||
app.on('ready', function() {
|
||||
window = new BrowserWindow({width: 800, height: 600});
|
||||
window.loadUrl('https://github.com');
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
And the web page is no different to a normal web page, except for the extra
|
||||
ability to use node modules:
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<body>
|
||||
<script>
|
||||
var remote = require('remote');
|
||||
console.log(remote.require('app').getVersion());
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
To run your app, read [Run your app](../tutorial/quick-start.md#run-your-app).
|
Loading…
Add table
Add a link
Reference in a new issue