@sutton-signwriting/sgnw-components

[Read Me](README.md) | [Using the Components](USAGE.md) | [<sgnw-components />](SGNW-COMPONENTS.md) | [<fsw-components />](FSW-COMPONENTS.md) | [Change Log](CHANGELOG.md) --- # Formal SignWriting Web Components **<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. - [fsw-symbol](FSW-COMPONENTS.md#fsw-symbol) - [fsw-sign](FSW-COMPONENTS.md#fsw-sign) - [fsw-vp](FSW-COMPONENTS.md#fsw-vp) - [fsw-button](FSW-COMPONENTS.md#fsw-button) - [fsw-palette-symbol](FSW-COMPONENTS.md#fsw-palette-symbol) - [fsw-palette](FSW-COMPONENTS.md#fsw-palette) - [fsw-signbox](FSW-COMPONENTS.md#fsw-signbox) --- ## fsw-symbol The fsw-symbol component can be used to create a symbol image ### fsw-symbol <fsw-symbol symbol="S10000"></fsw-symbol> <fsw-symbol symbol="S10000"></fsw-symbol> ### fsw-symbol with style string <fsw-symbol symbol="S10020" styling="-CZ2"></fsw-symbol> <fsw-symbol symbol="S10020" styling="-CZ2"></fsw-symbol>  ### Properties | Property | Attribute | Description | Type | Default | | --------- | --------- | ----------------------- | -------- | ----------- | | `styling` | `styling` | Style String for symbol | `string` | `undefined` | | `symbol` | `symbol` | FSW key for symbol | `string` | `undefined` | ### Dependencies #### Used by - [fsw-vp](#fsw-vp) #### Graph ```mermaid graph TD; fsw-vp --> fsw-symbol ``` ---------------------------------------------- ## fsw-sign The fsw-sign component can be used to create a sign image ### fsw-sign <fsw-sign sign="AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475"></fsw-sign> <fsw-sign sign="AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475"></fsw-sign> ### fsw-sign with style string <fsw-sign sign="AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475" styling="-CZ2"></fsw-sign> <fsw-sign sign="AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475" styling="-CZ2"></fsw-sign>  ### Properties | Property | Attribute | Description | Type | Default | | --------- | --------- | --------------------- | -------- | ----------- | | `sign` | `sign` | FSW string for sign | `string` | `undefined` | | `styling` | `styling` | Style String for sign | `string` | `undefined` | ### Dependencies #### Used by - [fsw-vp](#fsw-vp) #### Graph ```mermaid graph TD; fsw-vp --> fsw-sign ``` ---------------------------------------------- ## fsw-vp The fsw-vp component can be used to create a sign text paragraph ### fsw-vp <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> <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>  ### Properties | Property | Attribute | Description | Type | Default | | ---------- | ---------- | ------------- | --------- | ----------- | | `colorize` | `colorize` | Colorize flag | `boolean` | `undefined` | | `vp` | `vp` | FSW text | `string` | `undefined` | ### Dependencies #### Depends on - [fsw-sign](#fsw-sign) - [fsw-symbol](#fsw-symbol) #### Graph ```mermaid graph TD; fsw-vp --> fsw-sign fsw-vp --> fsw-symbol ``` ---------------------------------------------- ## fsw-button The fsw-button component can be used to create buttons with symbols, signs, and svg. ### Basic Example <fsw-button symbol="S10000"></fsw-button> <fsw-button symbol="S10000"></fsw-button>  ### Properties | Property | Attribute | Description | Type | Default | | -------- | --------- | ------------------- | -------- | ----------- | | `sign` | `sign` | FSW string for sign | `string` | `undefined` | | `svg` | `svg` | SVG icon | `string` | `undefined` | | `symbol` | `symbol` | FSW key for symbol | `string` | `undefined` | ### Dependencies #### Used by - [fsw-palette](#fsw-palette) #### Graph ```mermaid graph TD; fsw-palette --> fsw-button ``` ---------------------------------------------- ## fsw-palette-symbol The fsw-palette-symbol component is used inside the fsw-palette. ### Basic Example <fsw-palette-symbol style="height:5rem;width:5rem;display:inline-block" symbol="S10000"></fsw-palette-symbol> <fsw-palette-symbol symbol="S10000"></fsw-palette-symbol>  ### Properties | Property | Attribute | Description | Type | Default | | -------- | --------- | ------------------ | -------- | ----------- | | `symbol` | `symbol` | FSW key for symbol | `string` | `undefined` | ### Events | Event | Description | Type | | -------------------- | --------------------------------------- | -------------------------------------------------------------------------- | | `paletteSymbolClick` | click event for the symbol palette | `CustomEvent<string>` | | `paletteSymbolDrop` | drop event for the signbox and sequence | `CustomEvent<{ encoding: string; symbol: string; x: number; y: number; }>` | ### Dependencies #### Used by - [fsw-palette](#fsw-palette) #### Graph ```mermaid graph TD; fsw-palette --> fsw-palette-symbol style fsw-palette-symbol fill:#f9f,stroke:#333,stroke-width:4px ``` ---------------------------------------------- ## fsw-palette The fsw-palette components allows for access to the symbols of the ISWA 2010. ### Basic Example <div style="height: 30vh; width: 90%; border: 1px solid yellow;"><fsw-palette orientation="horizontal" size="small"></fsw-palette></div> <fsw-palette orientation="horizontal" size="small"></fsw-palette>  ### Properties | Property | Attribute | Description | Type | Default | | ------------- | ------------- | --------------------------------- | -------------------------------- | ------------- | | `alphabet` | `alphabet` | set of symbols | `object \| string` | `iswa2010FSW` | | `base` | `base` | mid level symbol selection | `string` | `null` | | `group` | `group` | top level symbol selection | `string` | `null` | | `lower` | `lower` | flag for small and medium palette | `boolean` | `false` | | `more` | `more` | flag for small palette | `boolean` | `false` | | `orientation` | `orientation` | orientation of palette | `"horizontal" \| "vertical"` | `"vertical"` | | `size` | `size` | size of palette | `"large" \| "medium" \| "small"` | `"small"` | ### Dependencies #### Depends on - [fsw-button](#fsw-button) - [fsw-palette-symbol](#fsw-palette-symbol) #### Graph ```mermaid graph TD; fsw-palette --> fsw-button fsw-palette --> fsw-palette-symbol ``` ---------------------------------------------- ## fsw-signbox The fsw-signbox component is currently a placeholder for future development. It currently listens for the paletteSymbolDrop event and console logs the results. ### Basic Example <div style="height: 30vh; width: 30%; border: 1px solid yellow;"><fsw-signbox></fsw-signbox></div> <fsw-signbox></fsw-signbox>  ----------------------------------------------