@alex-arriaga/stencil-sg-virtual-2020
v0.0.1
Published
Stencil Component Starter
Downloads
49
Readme
Web Components with StencilJS
SG Virtual - Dec 04th, 2020
This is a demo project about how to create re-usable web components with Stencil.
Setup
Clone and install dependencies
git clone https://github.com/alex-arriaga/stencil-sg-virtual-2020.git
cd stencil-sg-virtual-2020
npm install
Start demo server (JSON API)
npm run api:serve
Start front-end site (Stencil components demo)
npm start
To build the components for production, run:
npm run build
To run the unit tests for the components, run:
npm test
Need help? Check out our docs here.
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
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
.