Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ionic-team/stencil-component-starter
Minimal starter project for building shareable web components with Stencil
https://github.com/ionic-team/stencil-component-starter
Last synced: 27 days ago
JSON representation
Minimal starter project for building shareable web components with Stencil
- Host: GitHub
- URL: https://github.com/ionic-team/stencil-component-starter
- Owner: ionic-team
- License: mit
- Created: 2017-09-15T14:39:47.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T23:06:05.000Z (7 months ago)
- Last Synced: 2024-04-13T17:37:37.677Z (7 months ago)
- Language: TypeScript
- Homepage: https://github.com/ionic-team/stencil
- Size: 650 KB
- Stars: 271
- Watchers: 19
- Forks: 123
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-stenciljs - Stencil Component Starter
README
[](https://stenciljs.com)
# 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](https://github.com/ionic-team/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 runtime 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:
```bash
git clone https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin
```
and run:
```bash
npm install
npm start
```
To build the component for production, run:
```bash
npm run build
```
To run the unit tests for the components, run:
```bash
npm test
```
Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).
## Naming Components
When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: ``). 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
There are two strategies we recommend for using web components built with Stencil.
The first step for all two of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages).
You can read more about these different approaches in the [Stencil docs](https://stenciljs.com/docs/publishing).
### Lazy Loading
If your Stencil project is built with the [`dist`](https://stenciljs.com/docs/distribution) output target, you can import a small bootstrap script that registers all components and allows you to load individual component scripts lazily.
For example, given your Stencil project namespace is called `my-design-system`, to use `my-component` on any website, inject this into your HTML:
```html
```
This will only load the necessary scripts needed to render ``. Once more components of this package are used, they will automatically be loaded lazily.
You can also import the script as part of your `node_modules` in your applications entry file:
```tsx
import 'foobar-design-system/dist/foobar-design-system/foobar-design-system.esm.js';
```
Check out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-y6v26a?file=src%2Fmain.tsx).
### Standalone
If you are using a Stencil component library with `dist-custom-elements`, we recommend importing Stencil components individually in those files where they are needed.
To export Stencil components as standalone components make sure you have the [`dist-custom-elements`](https://stenciljs.com/docs/custom-elements) output target defined in your `stencil.config.ts`.
For example, given you'd like to use `` as part of a React component, you can import the component directly via:
```tsx
import 'foobar-design-system/my-component';
function App() {
return (
<>
>
);
}
export default App;
```
Check out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-b6zuds?file=src%2FApp.tsx).