https://github.com/samvera-labs/stencil-test-components
Playground for developing and exporting Web Components in the Stencil environment
https://github.com/samvera-labs/stencil-test-components
stencil-components stenciljs webcomponents
Last synced: 2 months ago
JSON representation
Playground for developing and exporting Web Components in the Stencil environment
- Host: GitHub
- URL: https://github.com/samvera-labs/stencil-test-components
- Owner: samvera-labs
- License: mit
- Created: 2020-09-10T17:15:38.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2021-10-14T20:30:55.000Z (almost 5 years ago)
- Last Synced: 2025-02-22T19:42:16.939Z (over 1 year ago)
- Topics: stencil-components, stenciljs, webcomponents
- Language: TypeScript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 17
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Stencil Test Components
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](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 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:
```bash
git clone git@github.com:samvera-labs/stencil-test-components.git
```
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 (this probably doesn't work yet):
```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 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](https://docs.npmjs.com/getting-started/publishing-npm-packages).
### Script tag (regular HTML site)
- Put a script tag similar to this `` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc
#### Test this locally
- Create a test directory on your local machine, and create a new boilerplate `index.html` file.
```bash
Ima Test
Stencil testing
```
- Copy and paste the compiled distribution folder `dist/stencil-test-components` into your test directory.
```bash
index.html
/stencil-test-components
... files here
```
- Fire up a local server, and open a browser tab to view your test `index.html` page:
```bash
npx serve
```
- Include your Stencil component files and components
```bash
...
Ima Test
...
Stencil test
```
### Test in a JS framework application
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
### Node Modules
- Run `npm install my-component --save`
- Put a script tag similar to this `` 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 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