Stencil Component Starter

This is a starter project for building a standalone Web Component using Stencil.

Stencil is also great for building entire apps. For that, use the stencil-app-starter instead.

Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.

Getting Started

To start building a new web component using Stencil, clone this repo to a new directory:

git clone [email protected]:nano-shells/shells-linechart-axis.git nanoshell-linechart-axis
cd nanoshell-linechart-axis

and run:

npm install
npm run setup
npm run start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Need help? Check out our docs here.

Setup

Once cloned you will have a default component nanoshell-linechart-axis. There are a number of files that have to be modified to make the components and repository specific to your need. To help you there is a helper script that can be called by running npm setup. This will ask for a NPM package name for the internal ONT NPM registry as well as the component name you would like to build. The script will automatically rename files and remove the git remote origin so that you don't overwrite the starter project

Naming Components

When creating new component tags, we recommend not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!

Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion.

Using this component

Script tag

• Publish to NPM
• Put a script tag similar to this <script src='https://unpkg.com/[email protected]/dist/mycomponent.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Node Modules

• Run npm install nanoshell-linechart-axis --save
• Put a script tag similar to this <script src='node_modules/nanoshell-linechart-axis/dist/mycomponent.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

• Run npm install nanoshell-linechart-axis --save
• Add an import to the npm packages import nanoshell-linechart-axis;
• Then you can use the element anywhere in your template, JSX, html etc