xof-tree

Tree component built in Typescript with Lit-element

Usage no npm install needed!

<script type="module">
  import xofTree from 'https://cdn.skypack.dev/xof-tree';
</script>

README

<xof-tree>

This webcomponent follows the open-wc recommendation.

Experimental

It's still a very early stage of the component. Only one version deployed and currently trying in a project.

Demo

You can test the component here: Netlify

Performance

You can test the performace with this command: npm run tach performance/longdata.html npm run tach performance/longdata-expanded.html

Installation

npm i xof-tree

Usage

<script type="module">
  import 'xof-tree/xof-tree.js';
</script>

<xof-tree></xof-tree>

Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

npm run lint

You can lint with ESLint and Prettier individually as well

npm run lint:eslint
npm run lint:prettier

To automatically fix many linting errors, run

npm run format

You can format using ESLint and Prettier individually as well

npm run format:eslint
npm run format:prettier

Testing with Web Test Runner

To run the suite of Web Test Runner tests, run

npm run test

To run the tests in watch mode (for TDD, for example), run

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html