scu-web-components 0.0.94 → 0.0.95

package/dist/docs/components/ScwInputField.json

@@ -1,592 +0,0 @@
-{
-  "path": "src/scw-input-field/scw-input-field.ts",
-  "kind": "class",
-  "description": "",
-  "name": "ScwInputField",
-  "cssProperties": [
-    {
-      "description": "Adding padding this way will grow the input's hit area.",
-      "name": "--scw-input-padding"
-    },
-    {
-      "description": "Makes sure that the input fits within your default size",
-      "name": "--min-height"
-    }
-  ],
-  "members": [
-    {
-      "kind": "field",
-      "name": "name",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "(ScwInputField) name to identify form element and attach data",
-      "attribute": "name"
-    },
-    {
-      "kind": "field",
-      "name": "value",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "(ScwInputField) name to identify form element and attach data",
-      "attribute": "value"
-    },
-    {
-      "kind": "field",
-      "name": "type",
-      "type": {
-        "text": "InputTypes"
-      },
-      "description": "(ScwInputField) type of input field",
-      "attribute": "type"
-    },
-    {
-      "kind": "field",
-      "name": "readOnly",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwInputField) read-only status",
-      "attribute": "readonly"
-    },
-    {
-      "kind": "field",
-      "name": "focused",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwInputField) More of a state, element is focused",
-      "attribute": "focused",
-      "reflects": true
-    },
-    {
-      "kind": "field",
-      "name": "selectAllOnFocus",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwInputField) entire input string will be selected on focus",
-      "attribute": "select-all-on-focus"
-    },
-    {
-      "kind": "field",
-      "name": "inputmode",
-      "type": {
-        "text": "string"
-      },
-      "default": "'text'",
-      "description": "Tells browser what keyboard to use",
-      "attribute": "inputmode"
-    },
-    {
-      "kind": "field",
-      "name": "autoCapitalize",
-      "type": {
-        "text": "AutoCaptializeValues"
-      },
-      "description": "(ScwInputField) automatically capitalize input",
-      "attribute": "autocapitalize"
-    },
-    {
-      "kind": "field",
-      "name": "autoComplete",
-      "type": {
-        "text": "AutoCompleteValues"
-      },
-      "description": "(ScwInputField) automatically completes input",
-      "attribute": "autocomplete"
-    },
-    {
-      "kind": "field",
-      "name": "autoCorrect",
-      "type": {
-        "text": "AutoCorrectValues"
-      },
-      "description": "(ScwInputField) automatically correct input",
-      "attribute": "autocorrect"
-    },
-    {
-      "kind": "field",
-      "name": "autoFocus",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwInputField) automatically focus input",
-      "attribute": "autofocus"
-    },
-    {
-      "kind": "field",
-      "name": "placeholder",
-      "type": {
-        "text": "string | undefined"
-      },
-      "description": "placeholder text",
-      "attribute": "placeholder"
-    },
-    {
-      "kind": "field",
-      "name": "input",
-      "type": {
-        "text": "HTMLInputElement"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "valueDisplayed",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "valueDisplayed"
-    },
-    {
-      "kind": "field",
-      "name": "autoFormatter",
-      "type": {
-        "text": "AutoFormatter"
-      },
-      "description": "autoFormatter",
-      "default": "new AutoFormatter(this)"
-    },
-    {
-      "kind": "field",
-      "name": "lastFormattedValue",
-      "type": {
-        "text": "string | undefined"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "valueHandler",
-      "description": "watch value",
-      "parameters": [
-        {
-          "name": "oldValue",
-          "type": {
-            "text": "string"
-          }
-        },
-        {
-          "name": "newValue",
-          "type": {
-            "text": "string"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "method",
-      "name": "_formatValue",
-      "description": "Formats value"
-    },
-    {
-      "kind": "method",
-      "name": "handleChange",
-      "description": "handleChange",
-      "parameters": [
-        {
-          "name": "evt",
-          "type": {
-            "text": "Event"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "method",
-      "name": "handleInteraction",
-      "description": "handleInteraction"
-    },
-    {
-      "kind": "method",
-      "name": "focusHandler",
-      "description": "focusHandler"
-    },
-    {
-      "kind": "method",
-      "name": "blurHandler",
-      "description": "blurHandler"
-    },
-    {
-      "kind": "method",
-      "name": "valueChangeHandler",
-      "description": "valueChangeHandler"
-    },
-    {
-      "kind": "method",
-      "name": "invalidHandler",
-      "parameters": [
-        {
-          "name": "e",
-          "type": {
-            "text": "Event"
-          }
-        }
-      ],
-      "description": "invalidHandler"
-    },
-    {
-      "kind": "field",
-      "name": "element",
-      "type": {
-        "text": "string"
-      },
-      "description": "(ScwComponent) contains the root element name for each component\n(enum Components)",
-      "attribute": "element",
-      "reflects": true,
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "ariaLabel",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "(ScwComponent) Main text within component",
-      "attribute": "aria-label",
-      "reflects": true,
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "ariaDisabled",
-      "type": {
-        "text": "string"
-      },
-      "default": "'false'",
-      "description": "(ScwComponent) Disables the component however it disables",
-      "attribute": "aria-disabled",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "isLink",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwLinkBase)\nSome lookups need to know if something is a link or not...",
-      "attribute": "is-link",
-      "reflects": true,
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "_lightDomMutationObserver",
-      "type": {
-        "text": "LightDomMutationObserver | undefined"
-      },
-      "description": "(ScwComponent) Light Dom Mutation Observer",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "dynamic",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwComponent) Determines whether to watch for changes\nin children. (not all components use light DOM)",
-      "attribute": "dynamic",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "domMutated",
-      "description": "parseLightDom is a hook for classes extending this one to add\nother parsers and validations",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "warn",
-      "parameters": [
-        {
-          "name": "message",
-          "type": {
-            "text": "string"
-          },
-          "description": "describing warning"
-        }
-      ],
-      "description": "handles warnings...things wrong with formatting, ADA, etc...",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "clearWarnings",
-      "description": "clearWarnings",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "_lastWarning",
-      "type": {
-        "text": "string | undefined"
-      },
-      "description": "retain the last warning sent...good for testing.",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    }
-  ],
-  "events": [
-    {
-      "description": "input recieved focus",
-      "name": "scw-focus"
-    },
-    {
-      "description": "input lost focus",
-      "name": "scw-blur"
-    },
-    {
-      "description": "value has changed (not necessarily value displayed)",
-      "name": "scw-value-change"
-    }
-  ],
-  "attributes": [
-    {
-      "name": "name",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "(ScwInputField) name to identify form element and attach data",
-      "fieldName": "name"
-    },
-    {
-      "name": "value",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "(ScwInputField) name to identify form element and attach data",
-      "fieldName": "value"
-    },
-    {
-      "name": "type",
-      "type": {
-        "text": "InputTypes"
-      },
-      "description": "(ScwInputField) type of input field",
-      "fieldName": "type"
-    },
-    {
-      "name": "readonly",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwInputField) read-only status",
-      "fieldName": "readOnly"
-    },
-    {
-      "name": "focused",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwInputField) More of a state, element is focused",
-      "fieldName": "focused"
-    },
-    {
-      "name": "select-all-on-focus",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwInputField) entire input string will be selected on focus",
-      "fieldName": "selectAllOnFocus"
-    },
-    {
-      "name": "inputmode",
-      "type": {
-        "text": "string"
-      },
-      "default": "'text'",
-      "description": "Tells browser what keyboard to use",
-      "fieldName": "inputmode"
-    },
-    {
-      "name": "autocapitalize",
-      "type": {
-        "text": "AutoCaptializeValues"
-      },
-      "description": "(ScwInputField) automatically capitalize input",
-      "fieldName": "autoCapitalize"
-    },
-    {
-      "name": "autocomplete",
-      "type": {
-        "text": "AutoCompleteValues"
-      },
-      "description": "(ScwInputField) automatically completes input",
-      "fieldName": "autoComplete"
-    },
-    {
-      "name": "autocorrect",
-      "type": {
-        "text": "AutoCorrectValues"
-      },
-      "description": "(ScwInputField) automatically correct input",
-      "fieldName": "autoCorrect"
-    },
-    {
-      "name": "autofocus",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwInputField) automatically focus input",
-      "fieldName": "autoFocus"
-    },
-    {
-      "name": "placeholder",
-      "type": {
-        "text": "string | undefined"
-      },
-      "description": "placeholder text",
-      "fieldName": "placeholder"
-    },
-    {
-      "name": "aria-label",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "(ScwComponent) Main text within component",
-      "fieldName": "ariaLabel",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "name": "aria-disabled",
-      "type": {
-        "text": "string"
-      },
-      "default": "'false'",
-      "description": "(ScwComponent) Disables the component however it disables",
-      "fieldName": "ariaDisabled",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "name": "is-link",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwLinkBase)\nSome lookups need to know if something is a link or not...",
-      "fieldName": "isLink",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "name": "dynamic",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwComponent) Determines whether to watch for changes\nin children. (not all components use light DOM)",
-      "fieldName": "dynamic",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    },
-    {
-      "name": "element",
-      "type": {
-        "text": "string"
-      },
-      "description": "(ScwComponent) contains the root element name for each component\n(enum Components)",
-      "fieldName": "element",
-      "inheritedFrom": {
-        "name": "ScwComponent",
-        "module": "src/scw-component/ScwComponent.ts"
-      }
-    }
-  ],
-  "superclass": {
-    "name": "ScwComponent",
-    "module": "/src/scw-component/ScwComponent"
-  },
-  "tagName": "scw-input-field",
-  "customElement": true,
-  "category": "form",
-  "status": "alpha.review",
-  "releasedInVersion": "v0.0.4",
-  "adaStatus": "tbd",
-  "overview": "",
-  "examples": [
-    {
-      "title": "Simple Example",
-      "code": "\n        <scw-input-field\n          name=\"name\"\n          value=\"Your Value\">\n        </scw-input-field>"
-    },
-    {
-      "title": "Disabled",
-      "description": "Note it is 'aria-disabled'",
-      "code": "\n        <scw-input-field aria-disabled\n          name=\"phoneNumber\"\n          value=\"Disabled Text\">\n        </scw-input-field>"
-    },
-    {
-      "title": "Placeholder",
-      "description": "Placeholder text is a part of the text filed",
-      "code": "\n        <scw-input-field\n          name=\"phoneNumber\"\n          placeholder=\"Placeholder\">\n        </scw-input-field>"
-    },
-    {
-      "title": "Phone Number",
-      "description": "Formats input into US standard format (xxx) xxx-xxxx",
-      "code": "\n        <scw-input-field\n          name=\"phoneNumber\"\n          value=\"333\"\n          type=\"telephone\">\n        </scw-input-field>"
-    },
-    {
-      "title": "Events",
-      "description": "scw-input-field emits multiple events, see console log.",
-      "code": "\n        <scw-input-field\n          name=\"name\"\n          value=\"Events\">\n        </scw-input-field>\n        <script>\n          const input = document.currentScript.previousElementSibling;\n          input.addEventListener(\n            'scw-focus',\n            (evt) => console.log( 'focus', evt )\n          );\n          input.addEventListener(\n            'scw-blur',\n            (evt) => console.log( 'blur', evt )\n          );\n          input.addEventListener(\n            'scw-value-change',\n            (evt) => console.log( 'value-change', evt )\n          );\n        </script>"
-    },
-    {
-      "title": "Select All on Focus",
-      "code": "\n        <scw-input-field\n          name=\"name\"\n          value=\"Select All On Focus\"\n          select-all-on-focus>\n        </scw-input-field>"
-    }
-  ]
-}