https://github.com/proyecto26/stencil-ionic-components
Create StencilJS Components reusing Ionic components
https://github.com/proyecto26/stencil-ionic-components
stencil stencil-components stencil-js stencil-template stenciljs stenciljs-components
Last synced: 5 months ago
JSON representation
Create StencilJS Components reusing Ionic components
- Host: GitHub
- URL: https://github.com/proyecto26/stencil-ionic-components
- Owner: proyecto26
- License: mit
- Created: 2019-10-24T01:44:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-22T16:56:44.000Z (over 5 years ago)
- Last Synced: 2024-10-29T22:37:28.156Z (over 1 year ago)
- Topics: stencil, stencil-components, stencil-js, stencil-template, stenciljs, stenciljs-components
- Language: TypeScript
- Homepage:
- Size: 28.3 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Stencil Ionic Starter
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](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 https://github.com/ionic-team/stencil-component-starter.git my-components
cd my-components
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
### Script tag
- [Publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages)
- 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
### Node Modules
- Run `npm install my-components --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-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
## Contributing ✨
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](https://github.com/proyecto26/stencil-ionic-components/blob/master/CONTRIBUTING.md).
## Supporting 🍻
I believe in Unicorns 🦄
Support [me](http://www.paypal.me/jdnichollsc/2), if you do too.
## License ⚖️
This repository is available under the [MIT License](https://github.com/proyecto26/stencil-ionic-components/blob/master/LICENSE).
## Happy coding 💯
Made with ❤️
