The Volt Button is a button build on the Volt Design System. This button is built using 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.
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
buttontext |
buttontext |
The text to show inside the button | string |
"Button" |
buttontype |
buttontype |
Four button choices are: primary, callToAction, outline, and text | string |
"primary" |
- Use the following guides to integrate this component into your Angular 2+ project:
- https://stenciljs.com/docs/angular/#accessing-components-using-viewchild-and-viewchildren
- https://medium.com/@andypande/how-to-create-a-component-with-stencil-and-integrate-it-with-angular-2-5b52e8c0cdcc
- Run
npm install voltbuttontest --save - Put a script tag similar to this
<script src='node_modules/voltbuttontest/dist/mycomponent.js'></script>in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
<volt-button buttontext="Button" buttontype="primary"></volt-button>
- Run
npm install voltbuttontest --save - Add an import to the npm packages
import voltbuttontest; - Then you can use the element anywhere in your template, JSX, html etc