AmitMY / sgnw-components

A collection of web components for Sutton SignWriting

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@sutton-signwriting/sgnw-components

Gitter version npm downloads

@sutton-signwriting/sgnw-components is a javascript package for the browser that includes a collection of web components built with https://stenciljs.com/

This is an early release for testing and development. Feedback is welcome. Windows Edge browser is supported >= 79. To update Edge, download and reinstall.

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 for detailed specification.

Author: https://SteveSlevinski.me
Channel: https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow
Support: https://www.patreon.com/signwriting

Useful links

Using the Sutton SignWriting Web Components

Script tag

Put script tags similar to this

<script type="module" src="https://unpkg.com/@sutton-signwriting/sgnw-components@0.9.0/dist/sgnw-components/sgnw-components.esm.js"></script>
<link href="https://unpkg.com/@sutton-signwriting/sgnw-components@0.9.0/dist/sgnw-components/sgnw-components.css" rel="stylesheet">

Then you can use the elements anywhere in your template, JSX, html etc

Node Modules

  • Run npm install @sutton-signwriting/sgnw-components --save
  • 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
  • Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

  • Run npm install @sutton-signwriting/sgnw-components --save
  • Add an import to the npm packages import @sutton-signwriting/sgnw-components;
  • Then you can use the element anywhere in your template, JSX, html etc

License

MIT

SignWriting General Interest

About

A collection of web components for Sutton SignWriting

License:MIT License


Languages

Language:TypeScript 69.8%Language:JavaScript 22.5%Language:CSS 5.1%Language:HTML 2.6%