torii-ui
v0.0.8
Published
Thank you to the https://github.com/rebornix/vscode-webview-react project for providing a starting point for this React app, and tips on how to integrate it into VSCode.
Downloads
3
Readme
Torii
Thank you to the https://github.com/rebornix/vscode-webview-react project for providing a starting point for this React app, and tips on how to integrate it into VSCode.
VSCode integration is not handled in this repository. The Torii editor is meant to be pluggable into arbitrary IDEs. To see the code that integrates it with VSCode, check out https://github.com/andrewhead/vscode-torii and https://github.com/andrewhead/torii-editor-adapter.
To run the Torii tutorial editor in your integrated
development environment of choice, build the project (see
instructions below), open the index.html
in an embedded
browser in the environment, and run JavaScript initializing
the EditorAdapter
with a EditorConnector
that allows
communication with the IDE. The JavaScript will look like,
roughly:
new EditorAdapter(new MyEditorConnector(options));
For an example of initializing a EditorAdapter with an IDE-specific connector, see the code in the webview for the VSCode extension in https://github.com/andrewhead/vscode-torii.
Development
Run following commands in the terminal
npm install
npm run build
Then to test standalone (which will only provide a small subset of the functionality...), run:
npm run start
Development Conventions
- Apply styles using the
styled
function. - Unit tests should test unstyled components.
- Themes should be be applied in
styled
functions. If a component needs access to a theme, pass it in as a property. TheuseTheme
hook breaks in unit tests that use shallow rendering for components.