@stencila/components

@stencila/components

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.

Naming Components

Web Component tags may not be CamelCased and they must include a hyphen (-) in the name. Pleasee follow the pattern of <stencila-(component-type)>, for example <stencila-tab-list>.

Using these components

Script tag

• Publish to NPM
• Put a script tag similar to this <script src='https://unpkg.com/@stencila/components@0.0.1/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 @stencila/components --save
• Put a script tag similar to this <script src='node_modules/@stencila/components/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 @stencila/components --save
• Add an import to the npm packages import @stencila/components;
• Then you can use the element anywhere in your template, JSX, html etc