UNPKG

@sutton-signwriting/sgnw-components

Version:

a javascript package of web components for use with the SignWriting script.

1,649 lines (1,648 loc) 41.9 kB
{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/components/fsw-palette-symbol/fsw-palette-symbol.tsx", "declarations": [ { "kind": "class", "description": "", "name": "FswPaletteSymbol", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "draggie", "privacy": "protected" }, { "kind": "field", "name": "symbol", "type": { "text": "string" }, "description": "FSW key for symbol" }, { "kind": "field", "name": "sgnw", "type": { "text": "boolean" } }, { "kind": "method", "name": "paletteSymbolClickHandler" }, { "kind": "method", "name": "paletteSymbolDropHandler", "parameters": [ { "name": "{}" }, { "name": "pointer" } ] }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "symbol", "fieldName": "symbol", "type": { "text": "string" } } ], "tagName": "fsw-palette-symbol", "events": [ { "name": "paletteSymbolClick", "type": { "text": "EventEmitter<string>" }, "description": "click event for the symbol palette" }, { "name": "paletteSymbolDrop", "type": { "text": "EventEmitter<{encoding:string,symbol:string,x:number,y:number}>" }, "description": "drop event for the signbox and sequence" } ], "customElement": true } ], "exports": [ { "kind": "js", "name": "FswPaletteSymbol", "declaration": { "name": "FswPaletteSymbol", "module": "src/components/fsw-palette-symbol/fsw-palette-symbol.tsx" } }, { "kind": "custom-element-definition", "name": "fsw-palette-symbol", "declaration": { "name": "FswPaletteSymbol", "module": "src/components/fsw-palette-symbol/fsw-palette-symbol.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/fsw-button/fsw-button.tsx", "declarations": [ { "kind": "class", "description": "", "name": "FswButton", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "symbol", "type": { "text": "string" }, "description": "FSW key for symbol" }, { "kind": "field", "name": "sign", "type": { "text": "string" }, "description": "FSW string for sign" }, { "kind": "field", "name": "svg", "type": { "text": "string" }, "description": "SVG icon" }, { "kind": "field", "name": "sgnw", "type": { "text": "boolean" } }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "symbol", "fieldName": "symbol", "type": { "text": "string" } }, { "name": "sign", "fieldName": "sign", "type": { "text": "string" } }, { "name": "svg", "fieldName": "svg", "type": { "text": "string" } } ], "tagName": "fsw-button", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "FswButton", "declaration": { "name": "FswButton", "module": "src/components/fsw-button/fsw-button.tsx" } }, { "kind": "custom-element-definition", "name": "fsw-button", "declaration": { "name": "FswButton", "module": "src/components/fsw-button/fsw-button.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/fsw-sign/fsw-sign.tsx", "declarations": [ { "kind": "class", "description": "", "name": "FswSign", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "sign", "type": { "text": "string" }, "description": "FSW string for sign" }, { "kind": "field", "name": "styling", "type": { "text": "string" }, "description": "Style String for sign" }, { "kind": "field", "name": "sgnw", "type": { "text": "boolean" } }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "sign", "fieldName": "sign", "type": { "text": "string" } }, { "name": "styling", "fieldName": "styling", "type": { "text": "string" } } ], "tagName": "fsw-sign", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "FswSign", "declaration": { "name": "FswSign", "module": "src/components/fsw-sign/fsw-sign.tsx" } }, { "kind": "custom-element-definition", "name": "fsw-sign", "declaration": { "name": "FswSign", "module": "src/components/fsw-sign/fsw-sign.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/fsw-palette/fsw-palette.tsx", "declarations": [ { "kind": "class", "description": "", "name": "FswPalette", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "orientation", "type": { "text": "\"horizontal\" | \"vertical\"" }, "default": "\"vertical\"", "description": "orientation of palette" }, { "kind": "field", "name": "major", "type": { "text": "number" }, "default": "10" }, { "kind": "field", "name": "minor", "type": { "text": "number" }, "default": "3" }, { "kind": "field", "name": "total", "type": { "text": "number" }, "default": "30" }, { "kind": "field", "name": "size", "type": { "text": "\"small\" | \"medium\" | \"large\"" }, "default": "\"small\"", "description": "size of palette" }, { "kind": "method", "name": "parseSizeProp", "parameters": [ { "name": "newValue", "type": { "text": "string" } } ] }, { "kind": "field", "name": "alphabet", "type": { "text": "object | string" }, "default": "iswa2010FSW", "description": "set of symbols" }, { "kind": "field", "name": "group", "type": { "text": "string" }, "default": "null", "description": "top level symbol selection" }, { "kind": "method", "name": "watchGroup" }, { "kind": "field", "name": "base", "type": { "text": "string" }, "default": "null", "description": "mid level symbol selection" }, { "kind": "method", "name": "watchBase" }, { "kind": "field", "name": "more", "type": { "text": "boolean" }, "default": "false", "description": "flag for small palette" }, { "kind": "method", "name": "watchMore" }, { "kind": "field", "name": "hasMore", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "lower", "type": { "text": "boolean" }, "default": "false", "description": "flag for small and medium palette" }, { "kind": "method", "name": "watchLower" }, { "kind": "field", "name": "hasLower", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "palette", "type": { "text": "string[]" }, "default": "[]" }, { "kind": "method", "name": "getPaletteAll" }, { "kind": "method", "name": "getPaletteGroup" }, { "kind": "method", "name": "getPaletteBase" }, { "kind": "method", "name": "setPalette" }, { "kind": "method", "name": "paletteSymbolClickHandler", "parameters": [ { "name": "event", "type": { "text": "CustomEvent<string>" } } ] }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "orientation", "fieldName": "orientation", "type": { "text": "\"horizontal\" | \"vertical\"" } }, { "name": "size", "fieldName": "size", "type": { "text": "\"small\" | \"medium\" | \"large\"" } }, { "name": "alphabet", "fieldName": "alphabet", "type": { "text": "object | string" } }, { "name": "group", "fieldName": "group", "type": { "text": "string" } }, { "name": "base", "fieldName": "base", "type": { "text": "string" } }, { "name": "more", "fieldName": "more", "type": { "text": "boolean" } }, { "name": "lower", "fieldName": "lower", "type": { "text": "boolean" } } ], "tagName": "fsw-palette", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "FswPalette", "declaration": { "name": "FswPalette", "module": "src/components/fsw-palette/fsw-palette.tsx" } }, { "kind": "custom-element-definition", "name": "fsw-palette", "declaration": { "name": "FswPalette", "module": "src/components/fsw-palette/fsw-palette.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/fsw-signbox/fsw-signbox.tsx", "declarations": [ { "kind": "class", "description": "", "name": "FswSignbox", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "method", "name": "paletteSymbolDropHandler", "parameters": [ { "name": "event", "type": { "text": "CustomEvent<Object>" } } ] }, { "kind": "method", "name": "render" } ], "tagName": "fsw-signbox", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "FswSignbox", "declaration": { "name": "FswSignbox", "module": "src/components/fsw-signbox/fsw-signbox.tsx" } }, { "kind": "custom-element-definition", "name": "fsw-signbox", "declaration": { "name": "FswSignbox", "module": "src/components/fsw-signbox/fsw-signbox.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/fsw-spatial/fsw-spatial.tsx", "declarations": [ { "kind": "class", "description": "", "name": "FswSymbol", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "draggie", "privacy": "protected" }, { "kind": "method", "name": "render" } ], "tagName": "fsw-spatial", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "FswSymbol", "declaration": { "name": "FswSymbol", "module": "src/components/fsw-spatial/fsw-spatial.tsx" } }, { "kind": "custom-element-definition", "name": "fsw-spatial", "declaration": { "name": "FswSymbol", "module": "src/components/fsw-spatial/fsw-spatial.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/fsw-symbol/fsw-symbol.tsx", "declarations": [ { "kind": "class", "description": "", "name": "FswSymbol", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "symbol", "type": { "text": "string" }, "description": "FSW key for symbol" }, { "kind": "field", "name": "styling", "type": { "text": "string" }, "description": "Style String for symbol" }, { "kind": "field", "name": "sgnw", "type": { "text": "boolean" } }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "symbol", "fieldName": "symbol", "type": { "text": "string" } }, { "name": "styling", "fieldName": "styling", "type": { "text": "string" } } ], "tagName": "fsw-symbol", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "FswSymbol", "declaration": { "name": "FswSymbol", "module": "src/components/fsw-symbol/fsw-symbol.tsx" } }, { "kind": "custom-element-definition", "name": "fsw-symbol", "declaration": { "name": "FswSymbol", "module": "src/components/fsw-symbol/fsw-symbol.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/fsw-vp/fsw-vp.tsx", "declarations": [ { "kind": "class", "description": "", "name": "FswVp", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "vp", "type": { "text": "string" }, "description": "FSW text" }, { "kind": "field", "name": "colorize", "type": { "text": "boolean" }, "description": "Colorize flag" }, { "kind": "field", "name": "sgnw", "type": { "text": "boolean" } }, { "kind": "field", "name": "items", "type": { "text": "object[]" }, "default": "[]" }, { "kind": "method", "name": "parseText", "parameters": [ { "name": "newValue", "type": { "text": "string" } } ] }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "vp", "fieldName": "vp", "type": { "text": "string" } }, { "name": "colorize", "fieldName": "colorize", "type": { "text": "boolean" } } ], "tagName": "fsw-vp", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "FswVp", "declaration": { "name": "FswVp", "module": "src/components/fsw-vp/fsw-vp.tsx" } }, { "kind": "custom-element-definition", "name": "fsw-vp", "declaration": { "name": "FswVp", "module": "src/components/fsw-vp/fsw-vp.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/sgnw-palette/sgnw-palette.tsx", "declarations": [ { "kind": "class", "description": "", "name": "SgnwPalette", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "orientation", "type": { "text": "\"horizontal\" | \"vertical\"" }, "default": "\"vertical\"", "description": "orientation of palette" }, { "kind": "field", "name": "major", "type": { "text": "number" }, "default": "10" }, { "kind": "field", "name": "minor", "type": { "text": "number" }, "default": "3" }, { "kind": "field", "name": "total", "type": { "text": "number" }, "default": "30" }, { "kind": "field", "name": "size", "type": { "text": "\"small\" | \"medium\" | \"large\"" }, "default": "\"small\"", "description": "size of palette" }, { "kind": "method", "name": "parseSizeProp", "parameters": [ { "name": "newValue", "type": { "text": "string" } } ] }, { "kind": "field", "name": "alphabet", "type": { "text": "object | string" }, "default": "iswa2010SWU", "description": "set of symbols" }, { "kind": "field", "name": "group", "type": { "text": "string" }, "default": "null", "description": "top level symbol selection" }, { "kind": "method", "name": "watchGroup" }, { "kind": "field", "name": "base", "type": { "text": "string" }, "default": "null", "description": "mid level symbol selection" }, { "kind": "method", "name": "watchBase" }, { "kind": "field", "name": "more", "type": { "text": "boolean" }, "default": "false", "description": "flag for small palette" }, { "kind": "method", "name": "watchMore" }, { "kind": "field", "name": "hasMore", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "lower", "type": { "text": "boolean" }, "default": "false", "description": "flag for small and medium palette" }, { "kind": "method", "name": "watchLower" }, { "kind": "field", "name": "hasLower", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "palette", "type": { "text": "string[]" }, "default": "[]" }, { "kind": "method", "name": "getPaletteAll" }, { "kind": "method", "name": "getPaletteGroup" }, { "kind": "method", "name": "getPaletteBase" }, { "kind": "method", "name": "setPalette" }, { "kind": "method", "name": "paletteSymbolClickHandler", "parameters": [ { "name": "event", "type": { "text": "CustomEvent<string>" } } ] }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "orientation", "fieldName": "orientation", "type": { "text": "\"horizontal\" | \"vertical\"" } }, { "name": "size", "fieldName": "size", "type": { "text": "\"small\" | \"medium\" | \"large\"" } }, { "name": "alphabet", "fieldName": "alphabet", "type": { "text": "object | string" } }, { "name": "group", "fieldName": "group", "type": { "text": "string" } }, { "name": "base", "fieldName": "base", "type": { "text": "string" } }, { "name": "more", "fieldName": "more", "type": { "text": "boolean" } }, { "name": "lower", "fieldName": "lower", "type": { "text": "boolean" } } ], "tagName": "sgnw-palette", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "SgnwPalette", "declaration": { "name": "SgnwPalette", "module": "src/components/sgnw-palette/sgnw-palette.tsx" } }, { "kind": "custom-element-definition", "name": "sgnw-palette", "declaration": { "name": "SgnwPalette", "module": "src/components/sgnw-palette/sgnw-palette.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/sgnw-button/sgnw-button.tsx", "declarations": [ { "kind": "class", "description": "", "name": "SgnwButton", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "symbol", "type": { "text": "string" }, "description": "SWU character for symbol" }, { "kind": "field", "name": "sign", "type": { "text": "string" }, "description": "SWU string for sign" }, { "kind": "field", "name": "svg", "type": { "text": "string" }, "description": "SVG icon" }, { "kind": "field", "name": "sgnw", "type": { "text": "boolean" } }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "symbol", "fieldName": "symbol", "type": { "text": "string" } }, { "name": "sign", "fieldName": "sign", "type": { "text": "string" } }, { "name": "svg", "fieldName": "svg", "type": { "text": "string" } } ], "tagName": "sgnw-button", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "SgnwButton", "declaration": { "name": "SgnwButton", "module": "src/components/sgnw-button/sgnw-button.tsx" } }, { "kind": "custom-element-definition", "name": "sgnw-button", "declaration": { "name": "SgnwButton", "module": "src/components/sgnw-button/sgnw-button.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/sgnw-palette-symbol/sgnw-palette-symbol.tsx", "declarations": [ { "kind": "class", "description": "", "name": "SgnwPaletteSymbol", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "draggie", "privacy": "protected" }, { "kind": "field", "name": "symbol", "type": { "text": "string" }, "description": "SWU character for symbol" }, { "kind": "field", "name": "sgnw", "type": { "text": "boolean" } }, { "kind": "method", "name": "paletteSymbolClickHandler" }, { "kind": "method", "name": "paletteSymbolDropHandler", "parameters": [ { "name": "{}" }, { "name": "pointer" } ] }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "symbol", "fieldName": "symbol", "type": { "text": "string" } } ], "tagName": "sgnw-palette-symbol", "events": [ { "name": "paletteSymbolClick", "type": { "text": "EventEmitter<string>" }, "description": "click event for the symbol palette" }, { "name": "paletteSymbolDrop", "type": { "text": "EventEmitter<{encoding:string,symbol:string,x:number,y:number}>" }, "description": "drop event for the signbox and sequence" } ], "customElement": true } ], "exports": [ { "kind": "js", "name": "SgnwPaletteSymbol", "declaration": { "name": "SgnwPaletteSymbol", "module": "src/components/sgnw-palette-symbol/sgnw-palette-symbol.tsx" } }, { "kind": "custom-element-definition", "name": "sgnw-palette-symbol", "declaration": { "name": "SgnwPaletteSymbol", "module": "src/components/sgnw-palette-symbol/sgnw-palette-symbol.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/sgnw-sign/sgnw-sign.tsx", "declarations": [ { "kind": "class", "description": "", "name": "SgnwSign", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "sign", "type": { "text": "string" }, "description": "SWU string for sign" }, { "kind": "field", "name": "styling", "type": { "text": "string" }, "description": "Style String for sign" }, { "kind": "field", "name": "sgnw", "type": { "text": "boolean" } }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "sign", "fieldName": "sign", "type": { "text": "string" } }, { "name": "styling", "fieldName": "styling", "type": { "text": "string" } } ], "tagName": "sgnw-sign", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "SgnwSign", "declaration": { "name": "SgnwSign", "module": "src/components/sgnw-sign/sgnw-sign.tsx" } }, { "kind": "custom-element-definition", "name": "sgnw-sign", "declaration": { "name": "SgnwSign", "module": "src/components/sgnw-sign/sgnw-sign.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/sgnw-symbol/sgnw-symbol.tsx", "declarations": [ { "kind": "class", "description": "", "name": "SgnwSymbol", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "symbol", "type": { "text": "string" }, "description": "SWU character for symbol" }, { "kind": "field", "name": "styling", "type": { "text": "string" }, "description": "Style String for symbol" }, { "kind": "field", "name": "sgnw", "type": { "text": "boolean" } }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "symbol", "fieldName": "symbol", "type": { "text": "string" } }, { "name": "styling", "fieldName": "styling", "type": { "text": "string" } } ], "tagName": "sgnw-symbol", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "SgnwSymbol", "declaration": { "name": "SgnwSymbol", "module": "src/components/sgnw-symbol/sgnw-symbol.tsx" } }, { "kind": "custom-element-definition", "name": "sgnw-symbol", "declaration": { "name": "SgnwSymbol", "module": "src/components/sgnw-symbol/sgnw-symbol.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/sgnw-signbox/sgnw-signbox.tsx", "declarations": [ { "kind": "class", "description": "", "name": "SgnwSignbox", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "method", "name": "paletteSymbolDropHandler", "parameters": [ { "name": "event", "type": { "text": "CustomEvent<Object>" } } ] }, { "kind": "method", "name": "render" } ], "tagName": "sgnw-signbox", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "SgnwSignbox", "declaration": { "name": "SgnwSignbox", "module": "src/components/sgnw-signbox/sgnw-signbox.tsx" } }, { "kind": "custom-element-definition", "name": "sgnw-signbox", "declaration": { "name": "SgnwSignbox", "module": "src/components/sgnw-signbox/sgnw-signbox.tsx" } } ] }, { "kind": "javascript-module", "path": "src/components/sgnw-vp/sgnw-vp.tsx", "declarations": [ { "kind": "class", "description": "", "name": "SgnwVp", "members": [ { "kind": "field", "name": "el", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "vp", "type": { "text": "string" }, "description": "SWU text" }, { "kind": "field", "name": "colorize", "type": { "text": "boolean" }, "description": "Colorize flag" }, { "kind": "field", "name": "sgnw", "type": { "text": "boolean" } }, { "kind": "field", "name": "items", "type": { "text": "object[]" }, "default": "[]" }, { "kind": "method", "name": "parseText", "parameters": [ { "name": "newValue", "type": { "text": "string" } } ] }, { "kind": "method", "name": "render" } ], "attributes": [ { "name": "vp", "fieldName": "vp", "type": { "text": "string" } }, { "name": "colorize", "fieldName": "colorize", "type": { "text": "boolean" } } ], "tagName": "sgnw-vp", "events": [], "customElement": true } ], "exports": [ { "kind": "js", "name": "SgnwVp", "declaration": { "name": "SgnwVp", "module": "src/components/sgnw-vp/sgnw-vp.tsx" } }, { "kind": "custom-element-definition", "name": "sgnw-vp", "declaration": { "name": "SgnwVp", "module": "src/components/sgnw-vp/sgnw-vp.tsx" } } ] } ] }