This is a starter project for building a standalone Web Component using Stencil with Ionic Components.
Stencil is also great for building entire apps. For that, use the stencil-app-starter instead.
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.
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-components
cd my-components
git remote rm originand run:
npm install
npm startTo build the component for production, run:
npm run buildTo run the unit tests for the components, run:
npm testNeed help? Check out our docs here.
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.
- Publish to NPM
- Put a script tag similar to this
<script src='https://unpkg.com/my-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
- Run
npm install my-components --save - Put a script tag similar to this
<script src='node_modules/my-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
- Run
npm install my-components --save - Add an import to the npm packages
import my-components; - Then you can use the element anywhere in your template, JSX, html etc
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated ❤️.
You can learn more about how you can contribute to this project in the contribution guide.
I believe in Unicorns 🦄 Support me, if you do too.
This repository is available under the MIT License.
Made with ❤️
