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 https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin

and run:

npm install
npm 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.

Available Components

Simple button

Examples

  <simple-button show-click theme="secondary">I'm a simple button</simple-button>

Properties

| Property | Attribute | Description | Type | Default | Values | | --------------- | ------------ | --------------------- | --------- | ----------- | ------------------------- | | showNbOfClick | show-click | Show number of clicks | boolean | false | true,false | | theme | theme | theme | string | 'primary' | 'primary','secondary' |

My Component

Examples

  <my-component first="Stencil" last="'Don't call me a framework' JS"></my-component>

Properties

| Property | Attribute | Description | Type | Default | | -------- | --------- | --------------- | -------- | ----------- | | first | first | The first name | string | undefined | | last | last | The last name | string | undefined | | middle | middle | The middle name | string | undefined |

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 web-component-stencil-test --save
• Put a script tag similar to this <script src='node_modules/web-component-stencil-test/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 web-component-stencil-test --save
• Add an import to the npm packages import web-component-stencil-test;
• Then you can use the element anywhere in your template, JSX, html etc

In a React app

• See https://stenciljs.com/docs/react

import React from 'react';
import ReactDOM from 'react-dom';
import './index.css';
import App from './App';
import registerServiceWorker from './registerServiceWorker';

// Import the loader
import { applyPolyfills, defineCustomElements } from 'web-component-stencil-test/loader';

ReactDOM.render(<App />, document.getElementById('root'));
registerServiceWorker();

applyPolyfills().then(() => {
  defineCustomElements(window);
});

In an Angular app

• See https://stenciljs.com/docs/angular