| 1 | [Read Me](README.md) |
|
| 2 | [Using the Components](USAGE.md) |
|
| 3 | [<sgnw-components />](SGNW-COMPONENTS.md) |
|
| 4 | [<fsw-components />](FSW-COMPONENTS.md) |
|
| 5 | [Change Log](CHANGELOG.md)
|
| 6 |
|
| 7 | ---
|
| 8 |
|
| 9 | # Formal SignWriting Web Components
|
| 10 |
|
| 11 | **<fsw-components />** use [Formal SignWriting in ASCII (FSW)](https://tools.ietf.org/id/draft-slevinski-formal-signwriting-09.html#name-formal-signwriting-in-ascii) characters.
|
| 12 |
|
| 13 | - [fsw-symbol](FSW-COMPONENTS.md#fsw-symbol)
|
| 14 | - [fsw-sign](FSW-COMPONENTS.md#fsw-sign)
|
| 15 | - [fsw-vp](FSW-COMPONENTS.md#fsw-vp)
|
| 16 | - [fsw-button](FSW-COMPONENTS.md#fsw-button)
|
| 17 | - [fsw-palette-symbol](FSW-COMPONENTS.md#fsw-palette-symbol)
|
| 18 | - [fsw-palette](FSW-COMPONENTS.md#fsw-palette)
|
| 19 | - [fsw-signbox](FSW-COMPONENTS.md#fsw-signbox)
|
| 20 |
|
| 21 | ---
|
| 22 |
|
| 23 | ## fsw-symbol
|
| 24 |
|
| 25 | The fsw-symbol component can be used to create a symbol image
|
| 26 |
|
| 27 | ### fsw-symbol
|
| 28 | <fsw-symbol symbol="S10000"></fsw-symbol>
|
| 29 |
|
| 30 | <fsw-symbol symbol="S10000"></fsw-symbol>
|
| 31 |
|
| 32 | ### fsw-symbol with style string
|
| 33 | <fsw-symbol symbol="S10020" styling="-CZ2"></fsw-symbol>
|
| 34 |
|
| 35 | <fsw-symbol symbol="S10020" styling="-CZ2"></fsw-symbol>
|
| 36 |
|
| 37 |
|
| 38 |
|
| 39 |
|
| 40 | ### Properties
|
| 41 |
|
| 42 | | Property | Attribute | Description | Type | Default |
|
| 43 | | --------- | --------- | ----------------------- | -------- | ----------- |
|
| 44 | | `styling` | `styling` | Style String for symbol | `string` | `undefined` |
|
| 45 | | `symbol` | `symbol` | FSW key for symbol | `string` | `undefined` |
|
| 46 |
|
| 47 |
|
| 48 | ### Dependencies
|
| 49 |
|
| 50 | #### Used by
|
| 51 |
|
| 52 | - [fsw-vp](#fsw-vp)
|
| 53 |
|
| 54 | #### Graph
|
| 55 | ```mermaid
|
| 56 | graph TD;
|
| 57 | fsw-vp --> fsw-symbol
|
| 58 |
|
| 59 | ```
|
| 60 |
|
| 61 | ----------------------------------------------
|
| 62 |
|
| 63 |
|
| 64 |
|
| 65 | ## fsw-sign
|
| 66 |
|
| 67 | The fsw-sign component can be used to create a sign image
|
| 68 |
|
| 69 | ### fsw-sign
|
| 70 | <fsw-sign sign="AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475"></fsw-sign>
|
| 71 |
|
| 72 | <fsw-sign sign="AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475"></fsw-sign>
|
| 73 |
|
| 74 | ### fsw-sign with style string
|
| 75 | <fsw-sign sign="AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475" styling="-CZ2"></fsw-sign>
|
| 76 |
|
| 77 | <fsw-sign sign="AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475" styling="-CZ2"></fsw-sign>
|
| 78 |
|
| 79 |
|
| 80 |
|
| 81 |
|
| 82 |
|
| 83 | ### Properties
|
| 84 |
|
| 85 | | Property | Attribute | Description | Type | Default |
|
| 86 | | --------- | --------- | --------------------- | -------- | ----------- |
|
| 87 | | `sign` | `sign` | FSW string for sign | `string` | `undefined` |
|
| 88 | | `styling` | `styling` | Style String for sign | `string` | `undefined` |
|
| 89 |
|
| 90 |
|
| 91 | ### Dependencies
|
| 92 |
|
| 93 | #### Used by
|
| 94 |
|
| 95 | - [fsw-vp](#fsw-vp)
|
| 96 |
|
| 97 | #### Graph
|
| 98 | ```mermaid
|
| 99 | graph TD;
|
| 100 | fsw-vp --> fsw-sign
|
| 101 |
|
| 102 | ```
|
| 103 |
|
| 104 | ----------------------------------------------
|
| 105 |
|
| 106 |
|
| 107 |
|
| 108 | ## fsw-vp
|
| 109 |
|
| 110 | The fsw-vp component can be used to create a sign text paragraph
|
| 111 |
|
| 112 | ### fsw-vp
|
| 113 | <fsw-vp vp="AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475 AS15a21S15a07S21100S2df04S2df14M521x538S15a07494x488S15a21498x489S2df04498x517S2df14497x461S21100479x486 AS1f010S10018S20600M519x524S10018485x494S1f010490x494S20600481x476 S38800464x496 AS10e00M507x515S10e00492x485 AS15d41S15a36S21100S26505M535x521S15d41464x479S15a36474x503S21100507x491S26505522x508 S38700463x496 AS10020M508x515S10020493x485 AS10011S28108S30a00M540x519S30a00482x482S10011519x489S28108519x461 AS10e00S10e08S20500S27100S2711cS20500S2fc00S30006S30002M544x527S10e08470x497S10e00516x497S30006482x482S20500519x484S20500471x484S27100504x464S2711c451x463S30002482x482S2fc00491x453 S38700463x496 AS10e20M508x515S10e20493x485 AS10011S28108S30a00M540x519S30a00482x482S10011519x489S28108519x461 AS10120S15a3aS26a02S20e00M529x518S15a3a502x506S20e00487x495S10120507x483S26a02471x491 AS10020S2df04S10000M527x516S10000512x486S10020473x486S2df04489x485 AS10012S19205S22a04S20e00M529x525S10012499x477S20e00499x491S19205472x476S22a04499x510 S38800464x496 AS15a21S2a20cS15a01S15a07M538x518S15a21515x483S15a07463x482S15a01466x483S2a20c493x490 AS10011S10019S2eb04S2eb48M523x536S2eb48485x504S10011502x463S2eb04507x497S10019477x472 AS19a00S19a08S22a04S22a14S2fb04M534x521S22a14475x503S19a00506x479S19a08467x479S22a04514x504S2fb04493x515 S38800464x496 AS1eb20S15a37S26507S26507S15a10S15a18S22b04S22b14M530x550S15a37470x456S15a10515x523S15a18481x523S1eb20490x468S22b14479x488S26507504x450S22b04514x489S26507516x460 AS1d117S26505S1d417M539x531S1d117460x468S1d417514x506S26505491x492 M517x522S1000a487x507S10041483x479 S38700463x496 AS20320S22e04M509x519S20320493x481S22e04492x501 S38800464x496 M532x516S1ce20469x485S20320495x500S18620514x486 S38700463x496 M533x538S1f110504x523S34d00482x482 M554x518S1920a481x484S19202501x484S26606524x483S26612446x483S20500496x507 S38700463x496 AS15d02S15d0aS20e00S22f00M522x524S22f00487x477S15d02495x500S15d0a479x505S20e00493x493 AS11500S20308S20e00S26a02S34600M525x562S20308503x547S11500510x515S20e00495x531S26a02478x525S34600482x482 S38700463x496 M551x542S1dc2f448x465S1dc01482x459S26605502x488S26615467x490S1e101526x509S1e12f488x510 AS18040S18048S2eb08S2eb4cS2fb00M532x538S18040501x523S18048467x511S2eb4c477x470S2eb08506x483S2fb00494x462 S38800464x496 M532x516S1ce20469x485S20320495x500S18620514x486 AS19a00S19a08S22a04S22a14S2fb04M534x521S22a14475x503S19a00506x479S19a08467x479S22a04514x504S2fb04493x515 S38700463x496 AS10011S10019S2eb04S2eb48M523x536S2eb48485x504S10011502x463S2eb04507x497S10019477x472 AS1eb20S15a06S29b0bM516x531S15a06484x468S1eb20492x483S29b0b484x496 AS20350S20358S22f04S22f14S30114M528x565S20350508x530S20358477x530S22f04503x551S22f14471x551S30114482x477 S38800464x496"></fsw-vp>
|
| 114 |
|
| 115 | <fsw-vp vp="AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475 AS15a21S15a07S21100S2df04S2df14M521x538S15a07494x488S15a21498x489S2df04498x517S2df14497x461S21100479x486 AS1f010S10018S20600M519x524S10018485x494S1f010490x494S20600481x476 S38800464x496 AS10e00M507x515S10e00492x485 AS15d41S15a36S21100S26505M535x521S15d41464x479S15a36474x503S21100507x491S26505522x508 S38700463x496 AS10020M508x515S10020493x485 AS10011S28108S30a00M540x519S30a00482x482S10011519x489S28108519x461 AS10e00S10e08S20500S27100S2711cS20500S2fc00S30006S30002M544x527S10e08470x497S10e00516x497S30006482x482S20500519x484S20500471x484S27100504x464S2711c451x463S30002482x482S2fc00491x453 S38700463x496 AS10e20M508x515S10e20493x485 AS10011S28108S30a00M540x519S30a00482x482S10011519x489S28108519x461 AS10120S15a3aS26a02S20e00M529x518S15a3a502x506S20e00487x495S10120507x483S26a02471x491 AS10020S2df04S10000M527x516S10000512x486S10020473x486S2df04489x485 AS10012S19205S22a04S20e00M529x525S10012499x477S20e00499x491S19205472x476S22a04499x510 S38800464x496 AS15a21S2a20cS15a01S15a07M538x518S15a21515x483S15a07463x482S15a01466x483S2a20c493x490 AS10011S10019S2eb04S2eb48M523x536S2eb48485x504S10011502x463S2eb04507x497S10019477x472 AS19a00S19a08S22a04S22a14S2fb04M534x521S22a14475x503S19a00506x479S19a08467x479S22a04514x504S2fb04493x515 S38800464x496 AS1eb20S15a37S26507S26507S15a10S15a18S22b04S22b14M530x550S15a37470x456S15a10515x523S15a18481x523S1eb20490x468S22b14479x488S26507504x450S22b04514x489S26507516x460 AS1d117S26505S1d417M539x531S1d117460x468S1d417514x506S26505491x492 M517x522S1000a487x507S10041483x479 S38700463x496 AS20320S22e04M509x519S20320493x481S22e04492x501 S38800464x496 M532x516S1ce20469x485S20320495x500S18620514x486 S38700463x496 M533x538S1f110504x523S34d00482x482 M554x518S1920a481x484S19202501x484S26606524x483S26612446x483S20500496x507 S38700463x496 AS15d02S15d0aS20e00S22f00M522x524S22f00487x477S15d02495x500S15d0a479x505S20e00493x493 AS11500S20308S20e00S26a02S34600M525x562S20308503x547S11500510x515S20e00495x531S26a02478x525S34600482x482 S38700463x496 M551x542S1dc2f448x465S1dc01482x459S26605502x488S26615467x490S1e101526x509S1e12f488x510 AS18040S18048S2eb08S2eb4cS2fb00M532x538S18040501x523S18048467x511S2eb4c477x470S2eb08506x483S2fb00494x462 S38800464x496 M532x516S1ce20469x485S20320495x500S18620514x486 AS19a00S19a08S22a04S22a14S2fb04M534x521S22a14475x503S19a00506x479S19a08467x479S22a04514x504S2fb04493x515 S38700463x496 AS10011S10019S2eb04S2eb48M523x536S2eb48485x504S10011502x463S2eb04507x497S10019477x472 AS1eb20S15a06S29b0bM516x531S15a06484x468S1eb20492x483S29b0b484x496 AS20350S20358S22f04S22f14S30114M528x565S20350508x530S20358477x530S22f04503x551S22f14471x551S30114482x477 S38800464x496"></fsw-vp>
|
| 116 |
|
| 117 |
|
| 118 |
|
| 119 |
|
| 120 |
|
| 121 | ### Properties
|
| 122 |
|
| 123 | | Property | Attribute | Description | Type | Default |
|
| 124 | | ---------- | ---------- | ------------- | --------- | ----------- |
|
| 125 | | `colorize` | `colorize` | Colorize flag | `boolean` | `undefined` |
|
| 126 | | `vp` | `vp` | FSW text | `string` | `undefined` |
|
| 127 |
|
| 128 |
|
| 129 | ### Dependencies
|
| 130 |
|
| 131 | #### Depends on
|
| 132 |
|
| 133 | - [fsw-sign](#fsw-sign)
|
| 134 | - [fsw-symbol](#fsw-symbol)
|
| 135 |
|
| 136 | #### Graph
|
| 137 | ```mermaid
|
| 138 | graph TD;
|
| 139 | fsw-vp --> fsw-sign
|
| 140 | fsw-vp --> fsw-symbol
|
| 141 |
|
| 142 | ```
|
| 143 |
|
| 144 | ----------------------------------------------
|
| 145 |
|
| 146 |
|
| 147 |
|
| 148 | ## fsw-button
|
| 149 |
|
| 150 | The fsw-button component can be used to create buttons with symbols, signs, and svg.
|
| 151 |
|
| 152 | ### Basic Example
|
| 153 |
|
| 154 | <fsw-button symbol="S10000"></fsw-button>
|
| 155 |
|
| 156 | <fsw-button symbol="S10000"></fsw-button>
|
| 157 |
|
| 158 |
|
| 159 |
|
| 160 |
|
| 161 | ### Properties
|
| 162 |
|
| 163 | | Property | Attribute | Description | Type | Default |
|
| 164 | | -------- | --------- | ------------------- | -------- | ----------- |
|
| 165 | | `sign` | `sign` | FSW string for sign | `string` | `undefined` |
|
| 166 | | `svg` | `svg` | SVG icon | `string` | `undefined` |
|
| 167 | | `symbol` | `symbol` | FSW key for symbol | `string` | `undefined` |
|
| 168 |
|
| 169 |
|
| 170 | ### Dependencies
|
| 171 |
|
| 172 | #### Used by
|
| 173 |
|
| 174 | - [fsw-palette](#fsw-palette)
|
| 175 |
|
| 176 | #### Graph
|
| 177 | ```mermaid
|
| 178 | graph TD;
|
| 179 | fsw-palette --> fsw-button
|
| 180 |
|
| 181 | ```
|
| 182 |
|
| 183 | ----------------------------------------------
|
| 184 |
|
| 185 |
|
| 186 |
|
| 187 | ## fsw-palette-symbol
|
| 188 |
|
| 189 | The fsw-palette-symbol component is used inside the fsw-palette.
|
| 190 |
|
| 191 | ### Basic Example
|
| 192 |
|
| 193 | <fsw-palette-symbol style="height:5rem;width:5rem;display:inline-block" symbol="S10000"></fsw-palette-symbol>
|
| 194 |
|
| 195 | <fsw-palette-symbol symbol="S10000"></fsw-palette-symbol>
|
| 196 |
|
| 197 |
|
| 198 |
|
| 199 |
|
| 200 | ### Properties
|
| 201 |
|
| 202 | | Property | Attribute | Description | Type | Default |
|
| 203 | | -------- | --------- | ------------------ | -------- | ----------- |
|
| 204 | | `symbol` | `symbol` | FSW key for symbol | `string` | `undefined` |
|
| 205 |
|
| 206 |
|
| 207 | ### Events
|
| 208 |
|
| 209 | | Event | Description | Type |
|
| 210 | | -------------------- | --------------------------------------- | -------------------------------------------------------------------------- |
|
| 211 | | `paletteSymbolClick` | click event for the symbol palette | `CustomEvent<string>` |
|
| 212 | | `paletteSymbolDrop` | drop event for the signbox and sequence | `CustomEvent<{ encoding: string; symbol: string; x: number; y: number; }>` |
|
| 213 |
|
| 214 |
|
| 215 | ### Dependencies
|
| 216 |
|
| 217 | #### Used by
|
| 218 |
|
| 219 | - [fsw-palette](#fsw-palette)
|
| 220 |
|
| 221 | #### Graph
|
| 222 | ```mermaid
|
| 223 | graph TD;
|
| 224 | fsw-palette --> fsw-palette-symbol
|
| 225 | style fsw-palette-symbol fill:#f9f,stroke:#333,stroke-width:4px
|
| 226 | ```
|
| 227 |
|
| 228 | ----------------------------------------------
|
| 229 |
|
| 230 |
|
| 231 |
|
| 232 | ## fsw-palette
|
| 233 |
|
| 234 | The fsw-palette components allows for access to the symbols of the ISWA 2010.
|
| 235 |
|
| 236 | ### Basic Example
|
| 237 |
|
| 238 | <div style="height: 30vh; width: 90%; border: 1px solid yellow;"><fsw-palette orientation="horizontal" size="small"></fsw-palette></div>
|
| 239 |
|
| 240 | <fsw-palette orientation="horizontal" size="small"></fsw-palette>
|
| 241 |
|
| 242 |
|
| 243 |
|
| 244 |
|
| 245 | ### Properties
|
| 246 |
|
| 247 | | Property | Attribute | Description | Type | Default |
|
| 248 | | ------------- | ------------- | --------------------------------- | -------------------------------- | ------------- |
|
| 249 | | `alphabet` | `alphabet` | set of symbols | `object \| string` | `iswa2010FSW` |
|
| 250 | | `base` | `base` | mid level symbol selection | `string` | `null` |
|
| 251 | | `group` | `group` | top level symbol selection | `string` | `null` |
|
| 252 | | `lower` | `lower` | flag for small and medium palette | `boolean` | `false` |
|
| 253 | | `more` | `more` | flag for small palette | `boolean` | `false` |
|
| 254 | | `orientation` | `orientation` | orientation of palette | `"horizontal" \| "vertical"` | `"vertical"` |
|
| 255 | | `size` | `size` | size of palette | `"large" \| "medium" \| "small"` | `"small"` |
|
| 256 |
|
| 257 |
|
| 258 | ### Dependencies
|
| 259 |
|
| 260 | #### Depends on
|
| 261 |
|
| 262 | - [fsw-button](#fsw-button)
|
| 263 | - [fsw-palette-symbol](#fsw-palette-symbol)
|
| 264 |
|
| 265 | #### Graph
|
| 266 | ```mermaid
|
| 267 | graph TD;
|
| 268 | fsw-palette --> fsw-button
|
| 269 | fsw-palette --> fsw-palette-symbol
|
| 270 |
|
| 271 | ```
|
| 272 |
|
| 273 | ----------------------------------------------
|
| 274 |
|
| 275 |
|
| 276 |
|
| 277 | ## fsw-signbox
|
| 278 |
|
| 279 | The fsw-signbox component is currently a placeholder for future development. It currently listens for the paletteSymbolDrop event and console logs the results.
|
| 280 |
|
| 281 | ### Basic Example
|
| 282 |
|
| 283 | <div style="height: 30vh; width: 30%; border: 1px solid yellow;"><fsw-signbox></fsw-signbox></div>
|
| 284 |
|
| 285 | <fsw-signbox></fsw-signbox>
|
| 286 |
|
| 287 |
|
| 288 |
|
| 289 |
|
| 290 | ----------------------------------------------
|
| 291 |
|
| 292 |
|