Skip to content

eclipse-emfcloud/theia-tree-editor

Repository files navigation

Eclipse EMF.cloud Theia Tree Editor build-status

License: EPL v2.0 License: MIT

Dependencies: JSONForms Theia

Theia tree editor provides a framework to build tree master detail editors for editing model based data in Eclipse Theia. An overview over the tree editor's features and customization capabilities can be found in this blog post.

The framework itself is located in theia-tree-editor. Documentation about the editor's components and how to set up a custom editor can be found in the documentation.

example contains a simple development example using the tree editor framework in a minimal Theia.

For more information, please visit the EMF.cloud Website. If you have questions, contact us on our discussions page and have a look at our communication and support options.

Available via NPM build-status-server

Quick Start via Yeoman Generator

The simplest way to get started with building your own editor is to look at an example. You can adapt the existing data model and learn how to customize the framework based on your specific requirements.

To get started, we provide a Yeoman generator that creates your own template project with a working example. The template is integrated into the Theia extension generator. To create the editor template project, install the extension generator and launch it:

npm install -g yo generator-theia-extension
mkdir my-extension && cd my-extension
yo theia-extension

For the extensions type, select “TreeEditor”

The template generator creates a tree editor based on an example data model. It also creates a Theia product that embeds the editor, so you can directly try it out with the following commands:

cd browser-app
yarn start

Developer Setup

Install nvm.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.36.0/install.sh | bash

Install npm and node.

nvm install 16
nvm use 16

Install yarn.

npm install -g yarn

Install dependencies and build framework and example

yarn

Running the Browser Example

yarn example

or

npm run example

The example Theia runs at http://localhost:3000.

License

This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License v. 2.0 are satisfied: MIT.

SPDX-License-Identifier: EPL-2.0 OR MIT