Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 3.58 KB

readme.md

File metadata and controls

40 lines (23 loc) · 3.58 KB

Built With Stencil

If this project has been useful to you and you want to help me to keep contributing to the open source with projects, examples, plugins,... collaborate and buy me a coffee.

Buy Me A Coffee

Stencil Star Rating Component

⭐ Star Rating Component is a standalone Web Component made with ❤️ and built 🛠 with Stencil (a framework-agnostic web component that works in Ionic, Angular, React, Vue, Remix, Vanilla javascript,.... ⭐

Stencil is also great for building entire apps. For that, use the stencil-app-starter instead.

If you have any doubts, please consult the official documentation

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.

Using this component

Script tag

  • Put a script tag similar to this <script type='module' src='https://unpkg.com/[email protected]/dist/star-rating-component.esm.js'></script> 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 star-rating-component --save
  • Put a script tag similar to this <script type='module' src='node_modules/star-rating-component/dist/star-rating-component.esm.js'></script> 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 star-rating-component --save
  • Add an import to the npm packages import star-rating-component;
  • Then you can use the element anywhere in your template, JSX, html, etc.