scu-components-beta
v0.0.10
Published
Summit Credit Union Design System Stencil Components
Downloads
333
Readme
#Install
yarn install
There are three dimensions to building components, Tokens, Reference, and the Components.
yarn tokens
yarn build:ref
yarn start
When publishing, it is important to build AFTER you increment the version.
[INCREMENT VERSION IN package.json!!!!!]
build:all
npm publish
Reference
The reference is generated with each build, so you can find the latest tokens and components via unpkg: https://unpkg.com/scu-components-beta/dist/scu/reference/components/scu-button/index.html
This will redirect you to the latest version. If you want a specific version, append it: https://unpkg.com/[email protected]/dist/scu/reference/components/scu-button/index.html
Using this component
Script tag
- Publish to NPM
- Put a script tag similar to this
<script src='https://unpkg.com/[email protected]/dist/scu.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 my-component --save
- Put a script tag similar to this
<script src='node_modules/scu-components/dist/scu.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 scu-components --save
- Add an import to the npm packages
import scu-components;
- Then you can use the element anywhere in your template, JSX, html etc