README
<detroit-btn>
Btn
Simple button component
Usage
To use this web component in your project you can utilize one of the following styles of syntax.
/* In an existing JS module / web component */
import '@cityofdetroit/detroit-btn/detroit-btn.js';
/* At top of an application with build routine */
<script type="module" src="@cityofdetroit/detroit-btn/detroit-btn.js"></script>
/* Alternatives for top of application */
<script type="module">
import '@cityofdetroit/detroit-btn/detroit-btn.js';
// imperative form
import {DetroitBtn} from '@cityofdetroit/detroit-btn';
// if you don't have a build routine and need to reference directly
import './node_modules/@cityofdetroit/detroit-btn/detroit-btn.js';
</script>
// via unpkg CDN (good for testing)
<script type="module" src="https://unpkg.com/@cityofdetroit/detroit-btn/detroit-btn.js"></script>
Develop / Demo
Run yarn start will start a local development server, open your default browser to display it, open your finder to the correct window and start watching the /src directory for changes and automatically rebuilding the element and documentation site for the demo.
$ yarn start
Test
$ yarn run test
Build
Builds ensure that wcfactory can correctly compile your web component project to work on the maximum number of browsers possible.
$ yarn run build
Contributing
- Fork it!
git clone git@github.com:CityOfDetroit/web-components.git - Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -m 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
Code style
Btn (and all web-components) use Prettier to auto-format JS and JSON. The style rules get applied when you commit a change. If you choose to, you can integrate your editor with Prettier to have the style rules applied on every save.