This repository has been archived by the owner on Jul 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 259
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #370 from MicrosoftDX/dev
Merge for v0.3
- Loading branch information
Showing
72 changed files
with
4,914 additions
and
683 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,16 @@ | ||
*.js.map | ||
*.min.js | ||
!verge.min.js | ||
!res.min.js | ||
!res.min.js | ||
!plugins/domtimeline/** | ||
!plugins/domtimeline/**/*.css | ||
!plugins/domtimeline/**/*.js | ||
!plugins/domtimeline/dom-timeline.js | ||
!plugins/express/** | ||
!plugins/express/**/*.css | ||
!plugins/express/**/*.js | ||
!plugins/express/dom-timeline.js | ||
!plugins/nodejs/** | ||
!plugins/nodejs/**/*.css | ||
!plugins/nodejs/**/*.js | ||
!plugins/nodejs/dom-timeline.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Sample plugin | ||
|
||
This is an example additional plugin for vorlon. It renders an input field into the Vorlon dashboard. If you type a message, it sends it to your client, which reverses it, and sends it back to be rendered into the dashboard. | ||
|
||
You can use this as a starting point for your own plugins. | ||
|
||
## Enabling the sample plugin | ||
|
||
To enable the sample plugin: | ||
|
||
1. Clone this github repo if you haven't already (`git clone [email protected]/MicrosoftDX/Vorlonjs`) | ||
2. Modify `Server/config.json` to add the plugin, so it looks like this: | ||
|
||
```json | ||
{ | ||
"includeSocketIO": true, | ||
"plugins": [ | ||
{ "id": "CONSOLE", "name": "Interactive Console", "panel": "bottom", "foldername" : "interactiveConsole", "enabled": true}, | ||
{ "id": "DOM", "name": "Dom Explorer", "panel": "top", "foldername" : "domExplorer", "enabled": true }, | ||
{ "id": "MODERNIZR", "name": "Modernizr","panel": "bottom", "foldername" : "modernizrReport", "enabled": true }, | ||
{ "id": "OBJEXPLORER", "name" : "Obj. Explorer","panel": "top", "foldername" : "objectExplorer", "enabled": true }, | ||
{ "id": "SAMPLE", "name" : "Sample","panel": "top", "foldername" : "sample", "enabled": true } | ||
] | ||
} | ||
``` | ||
|
||
3. From the root directory of the repository, install dependencies with `npm install`, build vorlon with `npm run build` and start the server with `npm start` (make sure you kill any existing vorlon servers running on your machine. You can now navigate to the vorlon dashboard as normal, and you'll see an additional tab in the list. | ||
|
||
## Modifying the plugin | ||
|
||
The plugin is based on two files (one for the client and one for the dashboard) who respectively extend from VORLON.ClientPlugin and VORLON.DashboardPlugin, as defined in `Plugins/Vorlon/vorlon.clientPlugin.ts` and `Plugins/Vorlon/vorlon.dashboardPlugin.ts` so you can see what methods are available for your plugin from there. You may also wish to look at the other existing plugins in `Plugins/Vorlon/plugins` for ideas. | ||
|
||
`control.html` will be inserted into the dashboard, as will `dashboard.css`. |
Oops, something went wrong.