| 1 | # sgnw-components
|
| 2 |
|
| 3 | [](https://gitter.im/sutton-signwriting/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
| 4 | [](https://www.npmjs.com/package/@sutton-signwriting/sgnw-components)
|
| 5 | [](https://npm-stat.com/charts.html?package=@sutton-signwriting/sgnw-components&from=2020-07-24)
|
| 6 |
|
| 7 | @sutton-signwriting/sgnw-components is a javascript package for the browser that includes a collection of web components built with https://stenciljs.com/
|
| 8 |
|
| 9 | This package supports both Formal SignWriting in ASCII (FSW) and SignWriting in Unicode (SWU) character sets, along with the associated query languages and style string. See [draft-slevinski-formal-signwriting](https://tools.ietf.org/id/draft-slevinski-formal-signwriting-07.html) for detailed specification.
|
| 10 |
|
| 11 | > Author: https://SteveSlevinski.me
|
| 12 | > Channel: https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow
|
| 13 | > Support: https://www.patreon.com/signwriting
|
| 14 |
|
| 15 | ## Useful links
|
| 16 |
|
| 17 | - Source: https://github.com/sutton-signwriting/sgnw-components
|
| 18 | - Distribution: https://unpkg.com/browse/@sutton-signwriting/sgnw-components/
|
| 19 | - Documentation: https://sutton-signwriting.github.io/sgnw-components/
|
| 20 | - Issue Tracker: https://github.com/sutton-signwriting/sgnw-components/issues
|
| 21 | - Online Discussion: https://gitter.im/sutton-signwriting/community
|
| 22 |
|
| 23 |
|
| 24 | ## Using the components
|
| 25 |
|
| 26 | ### Script tag
|
| 27 |
|
| 28 | Put script tags similar to this
|
| 29 |
|
| 30 | <script type="module" src="https://unpkg.com/@sutton-signwriting/sgnw-components@0.10.0/dist/sgnw-components/sgnw-components.esm.js"></script>
|
| 31 | <link type="text/css" rel="stylesheet" href="https://unpkg.com/@sutton-signwriting/sgnw-components@0.10.0/dist/sgnw-components/sgnw-components.css"/>
|
| 32 |
|
| 33 | Then you can use the elements anywhere in your template, JSX, html etc
|
| 34 |
|
| 35 | ### Node modules
|
| 36 | - Run `npm install @sutton-signwriting/sgnw-components --save`
|
| 37 | - Put a script tag similar to this `<script src='node_modules/@sutton-signwriting/sgnw-components/dist/sgnw-components.js'></script>` in the head of your index.html
|
| 38 | - Then you can use the element anywhere in your template, JSX, html etc
|
| 39 |
|
| 40 | ### In a stencil-starter app
|
| 41 | - Run `npm install @sutton-signwriting/sgnw-components --save`
|
| 42 | - Add an import to the npm packages `import '@sutton-signwriting/sgnw-components';`
|
| 43 | - Then you can use the element anywhere in your template, JSX, html etc
|
| 44 |
|
| 45 |
|
| 46 | ## License
|
| 47 | MIT
|
| 48 |
|
| 49 | ## SignWriting links
|
| 50 | - SignWriting Website: https://signwriting.org/
|
| 51 | - Wikipedia page: https://en.wikipedia.org/wiki/SignWriting
|
| 52 | - Email Discussion: https://www.signwriting.org/forums/swlist/
|
| 53 | - Facebook Group: https://www.facebook.com/groups/SuttonSignWriting/
|