This is a starter project for building a standalone Web Component(s) using Stencil.
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 git@github.com:samvera-labs/stencil-test-components.gitand run:
npm install
npm startTo build the component for production, run:
npm run buildTo run the unit tests for the components, run (this probably doesn't work yet):
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.
There are three strategies we recommend for using web components built with Stencil.
The first step for all three of these strategies is to publish to NPM.
- Put a script tag similar to this
<script src='https://unpkg.com/my-component@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
- Create a test directory on your local machine, and create a new boilerplate
index.htmlfile.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Ima Test</title>
</head>
<body>
<h1>Stencil testing</h1>
</body>
</html>- Copy and paste the compiled distribution folder
dist/stencil-test-componentsinto your test directory.
index.html
/stencil-test-components
... files here- Fire up a local server, and open a browser tab to view your test
index.htmlpage:
npx serve- Include your Stencil component files and components
...
<title>Ima Test</title>
<script
type="module"
src="stencil-test-components/stencil-test-components.esm.js"
></script>
...
<h1>Stencil test</h1>
<samvera-todo-list></samvera-todo-list>
<samvera-card
img-url="https://picsum.photos/300"
card-title="Random image"
description="So feel been kept be at gate. Be september it extensive oh concluded of certainty. In read most gate at body held it ever no. Talking justice welcome message inquiry in started of am me."
action-link="https://digitalcollections.library.northwestern.edu/items/80b2dd3f-aded-4610-9391-b534a9545552"
></samvera-card>
If you want to include this in a React, Vue or vanilla JS application, follow these setup instructions:
- https://stenciljs.com/docs/react
- https://stenciljs.com/docs/vue
- https://stenciljs.com/docs/javascript
- Run
npm install my-component --save - Put a script tag similar to this
<script src='node_modules/my-component/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-component --save - Add an import to the npm packages
import my-component; - Then you can use the element anywhere in your template, JSX, html etc