To open Stencil where everything is built:
- migrate to the cwru-components folder
git checkout mastergit remote updategit pullnvm use 12.10npm install
To start Stencil: npm run start,
To start Storybook: npm run storybook
After changes are complete:
- checkout a different branch
git add -Agit commit -m "MESSAGE"- git push then copy the command within the terminal and run that git push command
- create the pull request and merge it, and resolve any conflicts
git checkout mastergit remote updategit pull
Include the script and stylesheet tags in the <head> of all your html files. The script tag MUST include type="module".
<link href="https://cdn.jsdelivr.net/npm/cwru-components/dist/cwru-components/cwru-components.min.css" rel="stylesheet" />
<script type="module" src="https://cdn.jsdelivr.net/npm/cwru-components/dist/cwru-components/cwru-components.esm.min.js"></script>
<script nomodule src="https://cdn.jsdelivr.net/npm/cwru-components/dist/cwru-components/cwru-components.js"></script>The documentation is still under development. It lives on https://cwru.github.io/cwru-components/
When viewing a component, you can live update the attributes under the Controls tab at the bottom. When you are ready to use the component, click the HTML tab and the copy button at the bottom. This will keep all of the values you entered on the Controls tab.
This library is built using Stencil.js for generating the web components. We are using Storybook to create the docs.
The production version of the components live on NPM. To publish the latest version to NPM, first increase the version number in package.json and then run npm publish. Wait a few minutes and then check jsdeliver to see if the new version is available.
To update the components to show up on Storybook, npm run deploy-storybook