jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs

Browse Source 
Summary: renaming flipper in docs

Reviewed By: passy

Differential Revision: D9871491

fbshipit-source-id: 7a7dcc8421229f3a253efc6a49202dad5c7315d0
This commit is contained in:
Daniel Büchele
2018-09-18 06:38:30 -07:00
committed by Facebook Github Bot
parent 3e4c24d6fe
commit 159ce69bc8
7 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/jssetup.md
View File

@@ -18,12 +18,12 @@ To create the desktop part of your plugin, initiate a new JavaScript project usi
}
```
In `index.js` you can now create your plugin. We expect this file to have a default export of type `SonarPlugin`. A hello-world-plugin could look like this:
In `index.js` you can now create your plugin. We expect this file to have a default export of type `FlipperPlugin`. A hello-world-plugin could look like this:
```js
import {SonarPlugin} from 'sonar';
import {FlipperPlugin} from 'flipper';
export default class extends SonarPlugin {
export default class extends FlipperPlugin {
render() {
return 'hello world';
}
@@ -38,7 +38,7 @@ Once a plugin is created, Flipper can load it from its folder. The path from whe
### npm dependencies
If you need any dependencies in your plugin, you can install them using `yarn add`. The Flipper UI components exported from `sonar`, as well as `react` and `react-dom` don't need to be installed as dependencies. Our plugin-loader makes these dependencies available to your plugin.
If you need any dependencies in your plugin, you can install them using `yarn add`. The Flipper UI components exported from `flipper`, as well as `react` and `react-dom` don't need to be installed as dependencies. Our plugin-loader makes these dependencies available to your plugin.
### ES6, babel-transforms and bundling