scu-web-components 0.0.94 → 0.0.95

package/dist/docs/components/ScwSingleInput.json

@@ -1,869 +0,0 @@
-{
-  "path": "src/scw-single-input/scw-single-input.ts",
-  "kind": "class",
-  "description": "",
-  "name": "ScwSingleInput",
-  "members": [
-    {
-      "kind": "field",
-      "name": "scwInputField",
-      "type": {
-        "text": "any"
-      },
-      "description": "scw-input-field with versioning suffix"
-    },
-    {
-      "kind": "field",
-      "name": "scwSingleInputLayout",
-      "type": {
-        "text": "any"
-      },
-      "description": "scw-single-input-layout with versioning suffix"
-    },
-    {
-      "kind": "field",
-      "name": "scwForm",
-      "type": {
-        "text": "any"
-      },
-      "description": "scw-form with versioning suffix"
-    },
-    {
-      "kind": "field",
-      "name": "scwInputRef",
-      "type": {
-        "text": "Ref<ScwInputField>"
-      },
-      "description": "scw-form reference"
-    },
-    {
-      "kind": "field",
-      "name": "type",
-      "type": {
-        "text": "SingleInputTypes"
-      },
-      "description": "(ScwSingleInput) the type of input, determines what types of icons and\nbuttons show up on the input",
-      "attribute": "type"
-    },
-    {
-      "kind": "field",
-      "name": "action",
-      "type": {
-        "text": "string | undefined"
-      },
-      "description": "(ScwSingleInput) where to submit search, same as form",
-      "attribute": "action"
-    },
-    {
-      "kind": "field",
-      "name": "method",
-      "type": {
-        "text": "FormMethods"
-      },
-      "description": "(ScwSingleInput) how to submit search, same as form",
-      "attribute": "method"
-    },
-    {
-      "kind": "method",
-      "name": "typeWatcher",
-      "parameters": [
-        {
-          "name": "oldValue",
-          "type": {
-            "text": "string"
-          }
-        },
-        {
-          "name": "newValue",
-          "type": {
-            "text": "string"
-          }
-        }
-      ],
-      "description": "Watching type to adjust validation rules"
-    },
-    {
-      "kind": "method",
-      "name": "_focusHandler",
-      "description": "handle focus into input"
-    },
-    {
-      "kind": "method",
-      "name": "_blurHandler",
-      "description": "handle blurs from input"
-    },
-    {
-      "kind": "method",
-      "name": "_valueChangeHandler",
-      "parameters": [
-        {
-          "name": "evt",
-          "type": {
-            "text": "CustomEvent"
-          }
-        }
-      ],
-      "description": "handle changes from input"
-    },
-    {
-      "kind": "method",
-      "name": "_layoutActionHandler",
-      "parameters": [
-        {
-          "name": "evt",
-          "type": {
-            "text": "CustomEvent"
-          }
-        }
-      ],
-      "description": "handles actions from layout"
-    },
-    {
-      "kind": "method",
-      "name": "checkForSubmit",
-      "parameters": [
-        {
-          "name": "evt",
-          "type": {
-            "text": "KeyboardEvent"
-          }
-        }
-      ],
-      "description": "checkForSubmit"
-    },
-    {
-      "kind": "method",
-      "name": "submit",
-      "description": "submit"
-    },
-    {
-      "kind": "method",
-      "name": "renderInputField",
-      "return": {
-        "type": {
-          "text": "object"
-        }
-      },
-      "description": "render core input filed"
-    },
-    {
-      "kind": "method",
-      "name": "renderEmail",
-      "return": {
-        "type": {
-          "text": "object"
-        }
-      },
-      "description": "render email type"
-    },
-    {
-      "kind": "method",
-      "name": "renderSearch",
-      "return": {
-        "type": {
-          "text": "object"
-        }
-      },
-      "description": "render search type"
-    },
-    {
-      "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": "formType",
-      "type": {
-        "text": "ScwFormComponentTypes"
-      },
-      "description": "(ScwFormComponent) the usage in a form (& scw-form a query target)",
-      "attribute": "form-type",
-      "reflects": true,
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "name",
-      "type": {
-        "text": "string | undefined"
-      },
-      "description": "(ScwFormComponent) name to identify form element and attach data",
-      "attribute": "name",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "value",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "(ScwFormComponent) name to identify form element and attach data",
-      "attribute": "value",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "placeholder",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "(ScwFormComponent) text showing when there is no value",
-      "attribute": "placeholder",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "selected",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwFormComponent) name to identify form element and attach data",
-      "attribute": "selected",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "readOnly",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwFormComponent) read-only state management",
-      "attribute": "read-only",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "required",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwFormComponent) required state management",
-      "attribute": "required",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "requiredLabel",
-      "type": {
-        "text": "string"
-      },
-      "default": "' *'",
-      "description": "(ScwFormComponent) label indicator for required",
-      "attribute": "required-label",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "requiredFeedback",
-      "type": {
-        "text": "string | undefined"
-      },
-      "description": "(ScwFormComponent) label indicator for required",
-      "attribute": "required-feedback",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "feedback",
-      "type": {
-        "text": "string | undefined"
-      },
-      "description": "the text to use for feedback",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "focused",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "determines whether the input is focused or not",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "invalid",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "whether this form element is valid, passed validation",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "field",
-      "name": "input",
-      "type": {
-        "text": "HTMLInputElement"
-      },
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "decorateValues",
-      "return": {
-        "type": {
-          "text": "void"
-        }
-      },
-      "parameters": [
-        {
-          "name": "formData",
-          "type": {
-            "text": "Object"
-          }
-        }
-      ],
-      "description": "(ScwFormComponent) each form element to decorates the final data object",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "findIfRequired",
-      "return": {
-        "type": {
-          "text": "boolean"
-        }
-      },
-      "description": "Check to see if form element is required w/o knowing if there is validation",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "findValidationRules",
-      "return": {
-        "type": {
-          "text": "ScwValidation | undefined"
-        }
-      },
-      "description": "Find validation child if there...",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "validate",
-      "return": {
-        "type": {
-          "text": "ValidationResult[]"
-        }
-      },
-      "description": "run the validation rules if there...",
-      "parameters": [
-        {
-          "name": "value",
-          "type": {
-            "text": "string"
-          }
-        }
-      ],
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "createValidateRule",
-      "return": {
-        "type": {
-          "text": "ScwValidate"
-        }
-      },
-      "description": "create a validation rule from scratch",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "addValidationRule",
-      "parameters": [
-        {
-          "name": "rule",
-          "type": {
-            "text": "ScwValidate"
-          }
-        }
-      ],
-      "description": "add validation to to child validation (create if not there)",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "createAndAddValidationRule",
-      "parameters": [
-        {
-          "name": "type",
-          "type": {
-            "text": "ValidationTypes"
-          }
-        },
-        {
-          "name": "feedbackOverride",
-          "optional": true,
-          "type": {
-            "text": "string"
-          }
-        }
-      ],
-      "description": "create a validation of a certain type...",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "kind": "method",
-      "name": "removeValidationRule",
-      "parameters": [
-        {
-          "name": "type",
-          "type": {
-            "text": "ValidationTypes"
-          }
-        }
-      ],
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.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": "fires on valid or invalid submit (return or button). detail is {value: this.value, validation: []}",
-      "name": "scw-submit"
-    },
-    {
-      "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": "type",
-      "type": {
-        "text": "SingleInputTypes"
-      },
-      "description": "(ScwSingleInput) the type of input, determines what types of icons and\nbuttons show up on the input",
-      "fieldName": "type"
-    },
-    {
-      "name": "action",
-      "type": {
-        "text": "string | undefined"
-      },
-      "description": "(ScwSingleInput) where to submit search, same as form",
-      "fieldName": "action"
-    },
-    {
-      "name": "method",
-      "type": {
-        "text": "FormMethods"
-      },
-      "description": "(ScwSingleInput) how to submit search, same as form",
-      "fieldName": "method"
-    },
-    {
-      "name": "form-type",
-      "type": {
-        "text": "ScwFormComponentTypes"
-      },
-      "description": "(ScwFormComponent) the usage in a form (& scw-form a query target)",
-      "fieldName": "formType",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "name": "name",
-      "type": {
-        "text": "string | undefined"
-      },
-      "description": "(ScwFormComponent) name to identify form element and attach data",
-      "fieldName": "name",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "name": "value",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "(ScwFormComponent) name to identify form element and attach data",
-      "fieldName": "value",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "name": "placeholder",
-      "type": {
-        "text": "string"
-      },
-      "default": "''",
-      "description": "(ScwFormComponent) text showing when there is no value",
-      "fieldName": "placeholder",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "name": "selected",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwFormComponent) name to identify form element and attach data",
-      "fieldName": "selected",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "name": "read-only",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwFormComponent) read-only state management",
-      "fieldName": "readOnly",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "name": "required",
-      "type": {
-        "text": "boolean"
-      },
-      "default": "false",
-      "description": "(ScwFormComponent) required state management",
-      "fieldName": "required",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "name": "required-label",
-      "type": {
-        "text": "string"
-      },
-      "default": "' *'",
-      "description": "(ScwFormComponent) label indicator for required",
-      "fieldName": "requiredLabel",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "name": "required-feedback",
-      "type": {
-        "text": "string | undefined"
-      },
-      "description": "(ScwFormComponent) label indicator for required",
-      "fieldName": "requiredFeedback",
-      "inheritedFrom": {
-        "name": "ScwFormComponent",
-        "module": "src/scw-form-component/scw-form-component.ts"
-      }
-    },
-    {
-      "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": "ScwFormComponent",
-    "module": "/src/scw-form-component/scw-form-component"
-  },
-  "tagName": "scw-single-input",
-  "customElement": true,
-  "category": "form",
-  "status": "alpha.review",
-  "releasedInVersion": "v0.0.4",
-  "adaStatus": "tbd",
-  "overview": "",
-  "examples": [
-    {
-      "title": "Simple (Search Default)",
-      "code": "\n        <scw-single-input>\n        </scw-single-input>"
-    },
-    {
-      "title": "Search",
-      "code": "\n        <scw-single-input\n          type=\"search\"\n          placeholder=\"search\">\n        </scw-single-input>\n        <script>\n          const ele = document.currentScript.previousElementSibling;\n          ele.addEventListener('scw-submit', (evt) => console.log( evt ));\n        </script>"
-    },
-    {
-      "title": "Email",
-      "code": "\n        <scw-single-input\n          type=\"email\"\n          placeholder=\"Your Email\">\n        </scw-single-input>\n        <script>\n          const ele = document.currentScript.previousElementSibling;\n          ele.addEventListener('scw-submit', (evt) => console.log( evt ));\n        </script>"
-    },
-    {
-      "title": "Events (Console)",
-      "code": "\n        <scw-single-input\n          aria-label=\"Label\"\n          placeholder=\"Events\">\n        </scw-single-input>\n        <script>\n          const ele = document.currentScript.previousElementSibling;\n          ele.addEventListener(\n            'scw-value-change',\n            (evt) => console.log( 'scw-value-change', evt )\n          );\n          ele.addEventListener(\n            'scw-blur',\n            (evt) => console.log( 'scw-blur', evt )\n          );\n          ele.addEventListener(\n            'scw-focus',\n            (evt) => console.log( 'scw-focus', evt )\n          );\n          ele.addEventListener(\n            'scw-submit',\n            (evt) => console.log( 'scw-submit', evt )\n          );\n          ele.addEventListener(\n            'scw-action',\n            (evt) => console.log( 'scw-action', evt )\n          );\n        </script>"
-    }
-  ]
-}