@haxtheweb/lrndesign-sidenote
v9.0.1
Published
Automated conversion of lrndesign-sidenote/
Downloads
1,523
Readme
<lrndesign-sidenote>
Sidenote
Automated conversion of lrndesign-sidenote/
Usage
To use this web component in your project you can utilize one of the following styles of syntax.
/* In an existing module / web component */
import '@haxtheweb/lrndesign-sidenote.js';
/* At top of an application */
<script type="module" src="lrndesign-sidenote.js"></script>
/* Alternatives for top of application */
<script type="module">
import '@haxtheweb/lrndesign-sidenote.js';
import {LrndesignSidenote} from '@haxtheweb/lrndesign-sidenote';
</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 [email protected]/haxtheweb/webcomponents.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
Sidenote 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.