scu-web-components 0.0.97 → 0.0.99

package/dist/docs/components/ScwTableCell.json

@@ -0,0 +1,325 @@
+{
+  "path": "src/scw-table-cell/ScwTableCell.ts",
+  "kind": "class",
+  "description": "",
+  "name": "ScwTableCell",
+  "members": [
+    {
+      "kind": "field",
+      "name": "header",
+      "type": {
+        "text": "boolean"
+      },
+      "default": "false",
+      "description": "(ScwTableCell) If the cell is a header cell. Will be\nautomatically set if parent table-row has the header property",
+      "attribute": "header",
+      "reflects": true
+    },
+    {
+      "kind": "field",
+      "name": "labelCell",
+      "type": {
+        "text": "boolean"
+      },
+      "default": "false",
+      "description": "(ScwTableCell) If this cell is the first cell with the label",
+      "attribute": "label-cell",
+      "reflects": true
+    },
+    {
+      "kind": "field",
+      "name": "align",
+      "type": {
+        "text": "string | undefined"
+      },
+      "description": "(ScwTableCell) Text alignment for the cell (left or center).\nIf this is unset, it will be automatically set by parent table.",
+      "attribute": "align",
+      "reflects": true
+    },
+    {
+      "kind": "field",
+      "name": "linkLabel",
+      "type": {
+        "text": "string"
+      },
+      "default": "''",
+      "description": "(ScwTableCell) If the cell is a header cell and has a cta link",
+      "attribute": "cta-label"
+    },
+    {
+      "kind": "field",
+      "name": "link",
+      "type": {
+        "text": "string"
+      },
+      "default": "''",
+      "description": "(ScwTableCell) If the cell is a header cell and has a cta link",
+      "attribute": "cta-link"
+    },
+    {
+      "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"
+      }
+    }
+  ],
+  "attributes": [
+    {
+      "name": "header",
+      "type": {
+        "text": "boolean"
+      },
+      "default": "false",
+      "description": "(ScwTableCell) If the cell is a header cell. Will be\nautomatically set if parent table-row has the header property",
+      "fieldName": "header"
+    },
+    {
+      "name": "label-cell",
+      "type": {
+        "text": "boolean"
+      },
+      "default": "false",
+      "description": "(ScwTableCell) If this cell is the first cell with the label",
+      "fieldName": "labelCell"
+    },
+    {
+      "name": "align",
+      "type": {
+        "text": "string | undefined"
+      },
+      "description": "(ScwTableCell) Text alignment for the cell (left or center).\nIf this is unset, it will be automatically set by parent table.",
+      "fieldName": "align"
+    },
+    {
+      "name": "cta-label",
+      "type": {
+        "text": "string"
+      },
+      "default": "''",
+      "description": "(ScwTableCell) If the cell is a header cell and has a cta link",
+      "fieldName": "linkLabel"
+    },
+    {
+      "name": "cta-link",
+      "type": {
+        "text": "string"
+      },
+      "default": "''",
+      "description": "(ScwTableCell) If the cell is a header cell and has a cta link",
+      "fieldName": "link"
+    },
+    {
+      "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",
+    "package": "scw-component/ScwComponent"
+  },
+  "tagName": "scw-table-cell",
+  "customElement": true,
+  "category": "interactive",
+  "status": "alpha.review",
+  "releasedInVersion": "v0.0.3",
+  "adaStatus": "tbd",
+  "overview": "",
+  "examples": [
+    {
+      "title": "Basic",
+      "description": "Cells can be styled as a header or label depending on use\n      case.",
+      "code": "<scw-flex-h>\n      <scw-table-cell cta-link=\"#\" cta-label=\"bacon\" header>\n      test data</scw-table-cell>\n\n        <scw-table-cell label-cell>test data</scw-table-cell>\n        <scw-table-cell>test data</scw-table-cell>\n\n        </scw-flex-h>\n          "
+    },
+    {
+      "title": "Align",
+      "description": "Specify text alignment using the \"align\" attribute,\n      default is left. Only applies to header and regular cells - label cells\n      will always be left-aligned.\n      Setting this on an individual cell will override alignment set on table\n      (see scw-table for full example).",
+      "code": "<scw-flex-h>\n      <scw-table-cell\n        cta-link=\"#\"\n        cta-label=\"bacon\"\n        header\n        align=\"center\">\n        test data</scw-table-cell>\n\n        <scw-table-cell align=\"center\">test data</scw-table-cell>\n\n        </scw-flex-h>\n          "
+    }
+  ]
+}

package/dist/docs/components/ScwTableRow.json

@@ -0,0 +1,254 @@
+{
+  "path": "src/scw-table-row/ScwTableRow.ts",
+  "kind": "class",
+  "description": "",
+  "name": "ScwTableRow",
+  "members": [
+    {
+      "kind": "field",
+      "name": "header",
+      "type": {
+        "text": "boolean"
+      },
+      "default": "false",
+      "description": "(ScwTableRow) If the row is the header row",
+      "attribute": "header",
+      "reflects": true
+    },
+    {
+      "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"
+      }
+    }
+  ],
+  "attributes": [
+    {
+      "name": "header",
+      "type": {
+        "text": "boolean"
+      },
+      "default": "false",
+      "description": "(ScwTableRow) If the row is the header row",
+      "fieldName": "header"
+    },
+    {
+      "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",
+    "package": "scw-component/ScwComponent"
+  },
+  "tagName": "scw-table-row",
+  "customElement": true,
+  "category": "interactive",
+  "status": "alpha.review",
+  "releasedInVersion": "v0.0.3",
+  "adaStatus": "tbd",
+  "overview": "",
+  "examples": [
+    {
+      "title": "Basic",
+      "description": "A Basic row with cells inside.",
+      "code": "\n        <scw-table-row>\n        <scw-table-cell>test data</scw-table-cell>\n        <scw-table-cell>test data</scw-table-cell>\n        <scw-table-cell>test data</scw-table-cell>\n        <scw-table-cell>test data</scw-table-cell>\n        </scw-table-row>\n          "
+    },
+    {
+      "title": "Header",
+      "description": "Adding the \"header\" attribute applies the header styling\n      to the row and its nested cells.",
+      "code": "\n        <scw-table-row header>\n          <scw-table-cell>test data</scw-table-cell>\n          <scw-table-cell>test data</scw-table-cell>\n          <scw-table-cell>test data</scw-table-cell>\n          <scw-table-cell>test data</scw-table-cell>\n        </scw-table-row>\n          "
+    },
+    {
+      "title": "Label Cell",
+      "description": "Adding the \"label-cell\"\n      attribute to the first cell applies the label styling.",
+      "code": "\n        <scw-table-row header>\n          <scw-table-cell label-cell>test data</scw-table-cell>\n          <scw-table-cell>test data</scw-table-cell>\n          <scw-table-cell>test data</scw-table-cell>\n          <scw-table-cell>test data</scw-table-cell>\n        </scw-table-row>\n        <scw-table-row>\n          <scw-table-cell label-cell>test data</scw-table-cell>\n          <scw-table-cell>test data</scw-table-cell>\n          <scw-table-cell>test data</scw-table-cell>\n          <scw-table-cell>test data</scw-table-cell>\n        </scw-table-row>\n          "
+    }
+  ]
+}