From 9d6e65b6bfcb02a98164ad9e6c070c6eb51996b0 Mon Sep 17 00:00:00 2001 From: Marcus Hohlbein Date: Fri, 13 Feb 2026 15:44:03 +0100 Subject: [PATCH 01/42] add docs to repo --- core/src/components/cat-alert/docs.json | 136 + core/src/components/cat-avatar/docs.json | 296 + core/src/components/cat-badge/docs.json | 334 + .../src/components/cat-button-group/docs.json | 51 + core/src/components/cat-button/docs.json | 976 +++ core/src/components/cat-card/docs.json | 44 + core/src/components/cat-checkbox/docs.json | 686 ++ core/src/components/cat-date-inline/docs.json | 617 ++ core/src/components/cat-date/docs.json | 965 +++ .../cat-datepicker-inline/docs.json | 282 + core/src/components/cat-datepicker/docs.json | 1059 +++ core/src/components/cat-dropdown/docs.json | 525 ++ core/src/components/cat-form-group/docs.json | 122 + core/src/components/cat-icon/docs.json | 203 + core/src/components/cat-input/docs.json | 1294 ++++ core/src/components/cat-pagination/docs.json | 366 ++ core/src/components/cat-radio-group/docs.json | 232 + core/src/components/cat-radio/docs.json | 552 ++ core/src/components/cat-scrollable/docs.json | 291 + core/src/components/cat-select-demo/docs.json | 50 + core/src/components/cat-select/docs.json | 1042 +++ core/src/components/cat-skeleton/docs.json | 203 + core/src/components/cat-spinner/docs.json | 144 + core/src/components/cat-tab/docs.json | 414 ++ core/src/components/cat-tabs/docs.json | 306 + core/src/components/cat-tag/docs.json | 622 ++ core/src/components/cat-textarea/docs.json | 800 +++ core/src/components/cat-time/docs.json | 1038 +++ core/src/components/cat-toggle/docs.json | 598 ++ core/src/components/cat-tooltip/docs.json | 324 + core/stencil.config.ts | 29 +- docs/.gitignore | 30 + docs/README.md | 45 + docs/content/docs/components/alert.mdx | 107 + docs/content/docs/components/avatar.mdx | 77 + docs/content/docs/components/badge.mdx | 104 + docs/content/docs/components/button-group.mdx | 62 + docs/content/docs/components/button.mdx | 156 + docs/content/docs/components/card.mdx | 59 + docs/content/docs/components/checkbox.mdx | 83 + docs/content/docs/components/date-inline.mdx | 55 + docs/content/docs/components/date.mdx | 61 + .../docs/components/datepicker-inline.mdx | 10 + docs/content/docs/components/datepicker.mdx | 10 + docs/content/docs/components/dropdown.mdx | 64 + docs/content/docs/components/form-group.mdx | 55 + docs/content/docs/components/icon.mdx | 79 + docs/content/docs/components/index.mdx | 10 + docs/content/docs/components/input.mdx | 133 + docs/content/docs/components/pagination.mdx | 62 + docs/content/docs/components/radio-group.mdx | 64 + docs/content/docs/components/radio.mdx | 79 + docs/content/docs/components/scrollable.mdx | 63 + docs/content/docs/components/select.mdx | 115 + docs/content/docs/components/skeleton.mdx | 77 + docs/content/docs/components/spinner.mdx | 60 + docs/content/docs/components/tab.mdx | 77 + docs/content/docs/components/tabs.mdx | 64 + docs/content/docs/components/tag.mdx | 79 + docs/content/docs/components/textarea.mdx | 107 + docs/content/docs/components/time.mdx | 81 + docs/content/docs/components/toggle.mdx | 104 + docs/content/docs/components/tooltip.mdx | 98 + docs/content/docs/index.mdx | 3 + docs/content/docs/meta.json | 14 + docs/content/docs/start/start.mdx | 13 + docs/content/docs/tokens/color/base.mdx | 12 + docs/content/docs/tokens/color/compare.mdx | 28 + docs/content/docs/tokens/color/theme.mdx | 12 + docs/content/docs/tokens/color/ui.mdx | 12 + docs/content/docs/tokens/development.mdx | 75 + docs/content/docs/tokens/font/decoration.mdx | 10 + docs/content/docs/tokens/font/family.mdx | 10 + docs/content/docs/tokens/font/weight.mdx | 10 + docs/content/docs/tokens/index.mdx | 37 + docs/content/docs/tokens/opacity.mdx | 10 + docs/content/docs/tokens/size/border.mdx | 10 + docs/content/docs/tokens/size/font.mdx | 10 + docs/content/docs/tokens/size/modal.mdx | 10 + docs/content/docs/tokens/size/screen.mdx | 10 + docs/content/docs/tokens/size/spacing.mdx | 10 + docs/content/docs/tokens/time/delay.mdx | 10 + docs/content/docs/tokens/time/duration.mdx | 10 + docs/content/docs/tokens/time/transition.mdx | 10 + docs/content/docs/utilities/aspect-ratio.mdx | 78 + docs/content/docs/utilities/border.mdx | 102 + docs/content/docs/utilities/color.mdx | 128 + docs/content/docs/utilities/display.mdx | 90 + docs/content/docs/utilities/elevation.mdx | 118 + docs/content/docs/utilities/index.mdx | 59 + docs/content/docs/utilities/layout.mdx | 187 + docs/content/docs/utilities/media.mdx | 196 + docs/content/docs/utilities/meta.json | 14 + docs/content/docs/utilities/spacing.mdx | 162 + docs/content/docs/utilities/typography.mdx | 150 + docs/content/docs/utilities/visibility.mdx | 148 + docs/eslint.config.mjs | 15 + docs/next.config.mjs | 18 + docs/package.json | 45 + docs/postcss.config.mjs | 5 + docs/public/haiilo_logo.png | Bin 0 -> 47913 bytes docs/scripts/generate-api-docs.ts | 226 + docs/scripts/generate-token-docs.ts | 352 + docs/source.config.ts | 27 + docs/src/app/(home)/layout.tsx | 6 + docs/src/app/(home)/page.tsx | 16 + docs/src/app/api/search/route.ts | 7 + docs/src/app/docs/[[...slug]]/page.tsx | 68 + docs/src/app/docs/layout.tsx | 11 + docs/src/app/global.css | 3 + docs/src/app/layout.tsx | 23 + docs/src/app/llms-full.txt/route.ts | 10 + .../app/llms.mdx/docs/[[...slug]]/route.ts | 20 + docs/src/app/og/docs/[...slug]/route.tsx | 27 + docs/src/assets/Haiilo_Symbol_Ocean_RGB.png | Bin 0 -> 42633 bytes docs/src/components/ai/page-actions.tsx | 230 + docs/src/components/category-overview.tsx | 55 + docs/src/components/color-swatch.tsx | 360 ++ docs/src/components/copy-button.tsx | 70 + docs/src/components/live-preview.tsx | 345 + docs/src/components/skeleton.tsx | 13 + docs/src/components/status-badge.tsx | 17 + docs/src/lib/cn.ts | 1 + docs/src/lib/layout.shared.tsx | 23 + docs/src/lib/source.ts | 27 + docs/src/logo.svg | 11 + docs/src/mdx-components.tsx | 32 + docs/tsconfig.json | 49 + package.json | 18 +- pnpm-lock.yaml | 5732 ++++++++++++++++- pnpm-workspace.yaml | 1 + 131 files changed, 26341 insertions(+), 211 deletions(-) create mode 100644 core/src/components/cat-alert/docs.json create mode 100644 core/src/components/cat-avatar/docs.json create mode 100644 core/src/components/cat-badge/docs.json create mode 100644 core/src/components/cat-button-group/docs.json create mode 100644 core/src/components/cat-button/docs.json create mode 100644 core/src/components/cat-card/docs.json create mode 100644 core/src/components/cat-checkbox/docs.json create mode 100644 core/src/components/cat-date-inline/docs.json create mode 100644 core/src/components/cat-date/docs.json create mode 100644 core/src/components/cat-datepicker-inline/docs.json create mode 100644 core/src/components/cat-datepicker/docs.json create mode 100644 core/src/components/cat-dropdown/docs.json create mode 100644 core/src/components/cat-form-group/docs.json create mode 100644 core/src/components/cat-icon/docs.json create mode 100644 core/src/components/cat-input/docs.json create mode 100644 core/src/components/cat-pagination/docs.json create mode 100644 core/src/components/cat-radio-group/docs.json create mode 100644 core/src/components/cat-radio/docs.json create mode 100644 core/src/components/cat-scrollable/docs.json create mode 100644 core/src/components/cat-select-demo/docs.json create mode 100644 core/src/components/cat-select/docs.json create mode 100644 core/src/components/cat-skeleton/docs.json create mode 100644 core/src/components/cat-spinner/docs.json create mode 100644 core/src/components/cat-tab/docs.json create mode 100644 core/src/components/cat-tabs/docs.json create mode 100644 core/src/components/cat-tag/docs.json create mode 100644 core/src/components/cat-textarea/docs.json create mode 100644 core/src/components/cat-time/docs.json create mode 100644 core/src/components/cat-toggle/docs.json create mode 100644 core/src/components/cat-tooltip/docs.json create mode 100644 docs/.gitignore create mode 100644 docs/README.md create mode 100644 docs/content/docs/components/alert.mdx create mode 100644 docs/content/docs/components/avatar.mdx create mode 100644 docs/content/docs/components/badge.mdx create mode 100644 docs/content/docs/components/button-group.mdx create mode 100644 docs/content/docs/components/button.mdx create mode 100644 docs/content/docs/components/card.mdx create mode 100644 docs/content/docs/components/checkbox.mdx create mode 100644 docs/content/docs/components/date-inline.mdx create mode 100644 docs/content/docs/components/date.mdx create mode 100644 docs/content/docs/components/datepicker-inline.mdx create mode 100644 docs/content/docs/components/datepicker.mdx create mode 100644 docs/content/docs/components/dropdown.mdx create mode 100644 docs/content/docs/components/form-group.mdx create mode 100644 docs/content/docs/components/icon.mdx create mode 100644 docs/content/docs/components/index.mdx create mode 100644 docs/content/docs/components/input.mdx create mode 100644 docs/content/docs/components/pagination.mdx create mode 100644 docs/content/docs/components/radio-group.mdx create mode 100644 docs/content/docs/components/radio.mdx create mode 100644 docs/content/docs/components/scrollable.mdx create mode 100644 docs/content/docs/components/select.mdx create mode 100644 docs/content/docs/components/skeleton.mdx create mode 100644 docs/content/docs/components/spinner.mdx create mode 100644 docs/content/docs/components/tab.mdx create mode 100644 docs/content/docs/components/tabs.mdx create mode 100644 docs/content/docs/components/tag.mdx create mode 100644 docs/content/docs/components/textarea.mdx create mode 100644 docs/content/docs/components/time.mdx create mode 100644 docs/content/docs/components/toggle.mdx create mode 100644 docs/content/docs/components/tooltip.mdx create mode 100644 docs/content/docs/index.mdx create mode 100644 docs/content/docs/meta.json create mode 100644 docs/content/docs/start/start.mdx create mode 100644 docs/content/docs/tokens/color/base.mdx create mode 100644 docs/content/docs/tokens/color/compare.mdx create mode 100644 docs/content/docs/tokens/color/theme.mdx create mode 100644 docs/content/docs/tokens/color/ui.mdx create mode 100644 docs/content/docs/tokens/development.mdx create mode 100644 docs/content/docs/tokens/font/decoration.mdx create mode 100644 docs/content/docs/tokens/font/family.mdx create mode 100644 docs/content/docs/tokens/font/weight.mdx create mode 100644 docs/content/docs/tokens/index.mdx create mode 100644 docs/content/docs/tokens/opacity.mdx create mode 100644 docs/content/docs/tokens/size/border.mdx create mode 100644 docs/content/docs/tokens/size/font.mdx create mode 100644 docs/content/docs/tokens/size/modal.mdx create mode 100644 docs/content/docs/tokens/size/screen.mdx create mode 100644 docs/content/docs/tokens/size/spacing.mdx create mode 100644 docs/content/docs/tokens/time/delay.mdx create mode 100644 docs/content/docs/tokens/time/duration.mdx create mode 100644 docs/content/docs/tokens/time/transition.mdx create mode 100644 docs/content/docs/utilities/aspect-ratio.mdx create mode 100644 docs/content/docs/utilities/border.mdx create mode 100644 docs/content/docs/utilities/color.mdx create mode 100644 docs/content/docs/utilities/display.mdx create mode 100644 docs/content/docs/utilities/elevation.mdx create mode 100644 docs/content/docs/utilities/index.mdx create mode 100644 docs/content/docs/utilities/layout.mdx create mode 100644 docs/content/docs/utilities/media.mdx create mode 100644 docs/content/docs/utilities/meta.json create mode 100644 docs/content/docs/utilities/spacing.mdx create mode 100644 docs/content/docs/utilities/typography.mdx create mode 100644 docs/content/docs/utilities/visibility.mdx create mode 100644 docs/eslint.config.mjs create mode 100644 docs/next.config.mjs create mode 100644 docs/package.json create mode 100644 docs/postcss.config.mjs create mode 100644 docs/public/haiilo_logo.png create mode 100644 docs/scripts/generate-api-docs.ts create mode 100644 docs/scripts/generate-token-docs.ts create mode 100644 docs/source.config.ts create mode 100644 docs/src/app/(home)/layout.tsx create mode 100644 docs/src/app/(home)/page.tsx create mode 100644 docs/src/app/api/search/route.ts create mode 100644 docs/src/app/docs/[[...slug]]/page.tsx create mode 100644 docs/src/app/docs/layout.tsx create mode 100644 docs/src/app/global.css create mode 100644 docs/src/app/layout.tsx create mode 100644 docs/src/app/llms-full.txt/route.ts create mode 100644 docs/src/app/llms.mdx/docs/[[...slug]]/route.ts create mode 100644 docs/src/app/og/docs/[...slug]/route.tsx create mode 100644 docs/src/assets/Haiilo_Symbol_Ocean_RGB.png create mode 100644 docs/src/components/ai/page-actions.tsx create mode 100644 docs/src/components/category-overview.tsx create mode 100644 docs/src/components/color-swatch.tsx create mode 100644 docs/src/components/copy-button.tsx create mode 100644 docs/src/components/live-preview.tsx create mode 100644 docs/src/components/skeleton.tsx create mode 100644 docs/src/components/status-badge.tsx create mode 100644 docs/src/lib/cn.ts create mode 100644 docs/src/lib/layout.shared.tsx create mode 100644 docs/src/lib/source.ts create mode 100644 docs/src/logo.svg create mode 100644 docs/src/mdx-components.tsx create mode 100644 docs/tsconfig.json diff --git a/core/src/components/cat-alert/docs.json b/core/src/components/cat-alert/docs.json new file mode 100644 index 000000000..1e9aac68d --- /dev/null +++ b/core/src/components/cat-alert/docs.json @@ -0,0 +1,136 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-alert", + "filePath": "src/components/cat-alert/cat-alert.tsx", + "fileName": "cat-alert.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-alert/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-alert/usage", + "tag": "cat-alert", + "readme": "# cat-alert\n\n\n", + "overview": "Informs user about important changes or conditions in the interface. Use this\ncomponent if you need to capture user’s attention in a prominent way.", + "usage": {}, + "docs": "Informs user about important changes or conditions in the interface. Use this\ncomponent if you need to capture user’s attention in a prominent way.", + "docsTags": [], + "encapsulation": "shadow", + "dependents": [], + "dependencies": [ + "cat-icon" + ], + "dependencyGraph": { + "cat-alert": [ + "cat-icon" + ] + }, + "props": [ + { + "name": "color", + "type": "\"danger\" | \"none\" | \"primary\" | \"secondary\" | \"success\" | \"warning\"", + "complexType": { + "original": "'primary' | 'secondary' | 'danger' | 'success' | 'warning' | 'none'", + "resolved": "\"danger\" | \"none\" | \"primary\" | \"secondary\" | \"success\" | \"warning\"", + "references": {} + }, + "mutable": false, + "attr": "color", + "reflectToAttr": true, + "docs": "The color palette of the alert.", + "docsTags": [ + { + "name": "default", + "text": "'primary'" + } + ], + "default": "'primary'", + "values": [ + { + "value": "danger", + "type": "string" + }, + { + "value": "none", + "type": "string" + }, + { + "value": "primary", + "type": "string" + }, + { + "value": "secondary", + "type": "string" + }, + { + "value": "success", + "type": "string" + }, + { + "value": "warning", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "icon", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "icon", + "reflectToAttr": false, + "docs": "The name of an icon to be displayed in the alert.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "noIcon", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "no-icon", + "reflectToAttr": false, + "docs": "Whether the icon of the alert is deactivated.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [], + "events": [], + "styles": [], + "slots": [], + "parts": [], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-avatar/docs.json b/core/src/components/cat-avatar/docs.json new file mode 100644 index 000000000..15c359f11 --- /dev/null +++ b/core/src/components/cat-avatar/docs.json @@ -0,0 +1,296 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-avatar", + "filePath": "src/components/cat-avatar/cat-avatar.tsx", + "fileName": "cat-avatar.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-avatar/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-avatar/usage", + "tag": "cat-avatar", + "readme": "# cat-avatar\n\n\n", + "overview": "Avatars are used to represent a person or object.", + "usage": {}, + "docs": "Avatars are used to represent a person or object.", + "docsTags": [], + "encapsulation": "shadow", + "dependents": [ + "cat-select" + ], + "dependencies": [ + "cat-icon" + ], + "dependencyGraph": { + "cat-avatar": [ + "cat-icon" + ], + "cat-select": [ + "cat-avatar" + ] + }, + "props": [ + { + "name": "icon", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "icon", + "reflectToAttr": false, + "docs": "An icon to be used instead of the initials.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "initials", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "initials", + "reflectToAttr": false, + "docs": "Custom initials for the avatar.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "label", + "type": "string", + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "mutable": false, + "attr": "label", + "reflectToAttr": false, + "docs": "The label of the avatar.", + "docsTags": [ + { + "name": "default", + "text": "''" + } + ], + "default": "''", + "values": [ + { + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "round", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "round", + "reflectToAttr": false, + "docs": "Use round avatar edges.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "size", + "type": "\"l\" | \"m\" | \"s\" | \"xl\" | \"xs\"", + "complexType": { + "original": "'xs' | 's' | 'm' | 'l' | 'xl'", + "resolved": "\"l\" | \"m\" | \"s\" | \"xl\" | \"xs\"", + "references": {} + }, + "mutable": false, + "attr": "size", + "reflectToAttr": false, + "docs": "The size of the avatar.", + "docsTags": [ + { + "name": "default", + "text": "'m'" + } + ], + "default": "'m'", + "values": [ + { + "value": "l", + "type": "string" + }, + { + "value": "m", + "type": "string" + }, + { + "value": "s", + "type": "string" + }, + { + "value": "xl", + "type": "string" + }, + { + "value": "xs", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "src", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "src", + "reflectToAttr": false, + "docs": "An optional avatar image.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "url", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "url", + "reflectToAttr": false, + "docs": "A destination to link to, rendered in the href attribute of a link.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "urlTarget", + "type": "\"_blank\" | \"_self\" | undefined", + "complexType": { + "original": "'_blank' | '_self'", + "resolved": "\"_blank\" | \"_self\" | undefined", + "references": {} + }, + "mutable": false, + "attr": "url-target", + "reflectToAttr": false, + "docs": "Specifies where to open the linked document.", + "docsTags": [], + "values": [ + { + "value": "_blank", + "type": "string" + }, + { + "value": "_self", + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [], + "events": [], + "styles": [ + { + "name": "--cat-avatar-bg", + "annotation": "prop", + "docs": "The background color of the avatar." + }, + { + "name": "--cat-avatar-fill", + "annotation": "prop", + "docs": "The text color of the avatar." + }, + { + "name": "--cat-avatar-font-size", + "annotation": "prop", + "docs": "The font size of the avatar." + }, + { + "name": "--cat-avatar-size", + "annotation": "prop", + "docs": "The size of the avatar." + } + ], + "slots": [], + "parts": [], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-badge/docs.json b/core/src/components/cat-badge/docs.json new file mode 100644 index 000000000..10b888b93 --- /dev/null +++ b/core/src/components/cat-badge/docs.json @@ -0,0 +1,334 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-badge", + "filePath": "src/components/cat-badge/cat-badge.tsx", + "fileName": "cat-badge.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-badge/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-badge/usage", + "tag": "cat-badge", + "readme": "# cat-badge\n\n\n", + "overview": "Badges are used to inform users of the status of an object or of an action\nthat’s been taken.", + "usage": {}, + "docs": "Badges are used to inform users of the status of an object or of an action\nthat’s been taken.", + "docsTags": [], + "encapsulation": "shadow", + "dependents": [], + "dependencies": [ + "cat-icon" + ], + "dependencyGraph": { + "cat-badge": [ + "cat-icon" + ] + }, + "props": [ + { + "name": "color", + "type": "\"danger\" | \"info\" | \"primary\" | \"secondary\" | \"success\" | \"warning\"", + "complexType": { + "original": "'primary' | 'secondary' | 'info' | 'success' | 'warning' | 'danger'", + "resolved": "\"danger\" | \"info\" | \"primary\" | \"secondary\" | \"success\" | \"warning\"", + "references": {} + }, + "mutable": false, + "attr": "color", + "reflectToAttr": true, + "docs": "The color palette of the badge.", + "docsTags": [ + { + "name": "default", + "text": "'primary'" + } + ], + "default": "'primary'", + "values": [ + { + "value": "danger", + "type": "string" + }, + { + "value": "info", + "type": "string" + }, + { + "value": "primary", + "type": "string" + }, + { + "value": "secondary", + "type": "string" + }, + { + "value": "success", + "type": "string" + }, + { + "value": "warning", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "icon", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "icon", + "reflectToAttr": false, + "docs": "The name of an icon to be displayed in the button.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "iconOnly", + "type": "\"l\" | \"m\" | \"s\" | \"xl\" | \"xs\" | boolean", + "complexType": { + "original": "boolean | Breakpoint", + "resolved": "\"l\" | \"m\" | \"s\" | \"xl\" | \"xs\" | boolean", + "references": { + "Breakpoint": { + "location": "import", + "path": "../../utils/breakpoints", + "id": "src/utils/breakpoints.ts::Breakpoint" + } + } + }, + "mutable": false, + "attr": "icon-only", + "reflectToAttr": false, + "docs": "Hide the actual button content and only display the icon.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "value": "l", + "type": "string" + }, + { + "value": "m", + "type": "string" + }, + { + "value": "s", + "type": "string" + }, + { + "value": "xl", + "type": "string" + }, + { + "value": "xs", + "type": "string" + }, + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "iconRight", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "icon-right", + "reflectToAttr": false, + "docs": "Display the icon on the right.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "pulse", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "pulse", + "reflectToAttr": true, + "docs": "Draw attention to the badge with a subtle animation.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "round", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "round", + "reflectToAttr": true, + "docs": "Use round badge edges.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "size", + "type": "\"l\" | \"m\" | \"s\" | \"xl\" | \"xs\"", + "complexType": { + "original": "'xs' | 's' | 'm' | 'l' | 'xl'", + "resolved": "\"l\" | \"m\" | \"s\" | \"xl\" | \"xs\"", + "references": {} + }, + "mutable": false, + "attr": "size", + "reflectToAttr": true, + "docs": "The size of the badge.", + "docsTags": [ + { + "name": "default", + "text": "'m'" + } + ], + "default": "'m'", + "values": [ + { + "value": "l", + "type": "string" + }, + { + "value": "m", + "type": "string" + }, + { + "value": "s", + "type": "string" + }, + { + "value": "xl", + "type": "string" + }, + { + "value": "xs", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "variant", + "type": "\"filled\" | \"outlined\"", + "complexType": { + "original": "'filled' | 'outlined'", + "resolved": "\"filled\" | \"outlined\"", + "references": {} + }, + "mutable": false, + "attr": "variant", + "reflectToAttr": true, + "docs": "The rendering style of the badge.", + "docsTags": [ + { + "name": "default", + "text": "'filled'" + } + ], + "default": "'filled'", + "values": [ + { + "value": "filled", + "type": "string" + }, + { + "value": "outlined", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [], + "events": [], + "styles": [], + "slots": [], + "parts": [ + { + "name": "prefix", + "docs": "" + } + ], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-button-group/docs.json b/core/src/components/cat-button-group/docs.json new file mode 100644 index 000000000..d9c58728b --- /dev/null +++ b/core/src/components/cat-button-group/docs.json @@ -0,0 +1,51 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-button-group", + "filePath": "src/components/cat-button-group/cat-button-group.tsx", + "fileName": "cat-button-group.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-button-group/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-button-group/usage", + "tag": "cat-button-group", + "readme": "# cat-button-group\n\n\n", + "overview": "Button groups are designed to bring together button controls that are of a\nsimilar nature. For example text formatting controls.", + "usage": {}, + "docs": "Button groups are designed to bring together button controls that are of a\nsimilar nature. For example text formatting controls.", + "docsTags": [], + "encapsulation": "shadow", + "dependents": [], + "dependencies": [], + "dependencyGraph": {}, + "props": [ + { + "name": "a11yLabel", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "a11y-label", + "reflectToAttr": false, + "docs": "Adds an accessible label for the button group that\nit is only shown in assistive technologies, like screen readers.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [], + "events": [], + "styles": [], + "slots": [], + "parts": [], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-button/docs.json b/core/src/components/cat-button/docs.json new file mode 100644 index 000000000..de5da228a --- /dev/null +++ b/core/src/components/cat-button/docs.json @@ -0,0 +1,976 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-button", + "filePath": "src/components/cat-button/cat-button.tsx", + "fileName": "cat-button.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-button/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-button/usage", + "tag": "cat-button", + "readme": " # cat-button\n", + "overview": "Buttons are used for interface actions. Primary style should be used only\nonce per view for main call-to-action.", + "usage": {}, + "docs": "Buttons are used for interface actions. Primary style should be used only\nonce per view for main call-to-action.", + "docsTags": [ + { + "name": "part", + "text": "button - The native anchor or button element." + }, + { + "name": "part", + "text": "content - The textual content of the button." + }, + { + "name": "part", + "text": "prefix - The prefix icon." + }, + { + "name": "part", + "text": "suffix - The suffix icon." + } + ], + "encapsulation": "shadow", + "dependents": [ + "cat-date", + "cat-date-inline", + "cat-input", + "cat-pagination", + "cat-select", + "cat-select-demo", + "cat-tabs", + "cat-tag", + "cat-time" + ], + "dependencies": [ + "cat-icon", + "cat-spinner" + ], + "dependencyGraph": { + "cat-button": [ + "cat-icon", + "cat-spinner" + ], + "cat-date": [ + "cat-button" + ], + "cat-date-inline": [ + "cat-button" + ], + "cat-input": [ + "cat-button" + ], + "cat-pagination": [ + "cat-button" + ], + "cat-select": [ + "cat-button" + ], + "cat-select-demo": [ + "cat-button" + ], + "cat-tabs": [ + "cat-button" + ], + "cat-tag": [ + "cat-button" + ], + "cat-time": [ + "cat-button" + ] + }, + "props": [ + { + "name": "a11yCurrent", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "a11y-current", + "reflectToAttr": false, + "docs": "Sets the `aria-current` attribute on the button.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "a11yLabel", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "a11y-label", + "reflectToAttr": false, + "docs": "Adds accessible label for the button that is only shown for screen\nreaders. Typically, this label text replaces the visible text on the\nbutton for users who use assistive technology.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "active", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "active", + "reflectToAttr": false, + "docs": "Set the button into an active state.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "buttonGroupPosition", + "type": "\"first\" | \"last\" | \"middle\" | undefined", + "complexType": { + "original": "'first' | 'last' | 'middle'", + "resolved": "\"first\" | \"last\" | \"middle\" | undefined", + "references": {} + }, + "mutable": false, + "attr": "button-group-position", + "reflectToAttr": false, + "docs": "The index of a button that is used inside a cat-button-group component", + "docsTags": [], + "values": [ + { + "value": "first", + "type": "string" + }, + { + "value": "last", + "type": "string" + }, + { + "value": "middle", + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "buttonId", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "button-id", + "reflectToAttr": false, + "docs": "Adds a unique identifier for the button. Please note that with this\nparticular component this ID is added inside the web component. If you need\nan ID on the HTML element, use the regular `id` attribute instead.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "color", + "type": "\"danger\" | \"info\" | \"primary\" | \"secondary\" | \"success\" | \"warning\"", + "complexType": { + "original": "'primary' | 'secondary' | 'info' | 'success' | 'warning' | 'danger'", + "resolved": "\"danger\" | \"info\" | \"primary\" | \"secondary\" | \"success\" | \"warning\"", + "references": {} + }, + "mutable": false, + "attr": "color", + "reflectToAttr": false, + "docs": "The color palette of the button.", + "docsTags": [ + { + "name": "default", + "text": "'secondary'" + } + ], + "default": "'secondary'", + "values": [ + { + "value": "danger", + "type": "string" + }, + { + "value": "info", + "type": "string" + }, + { + "value": "primary", + "type": "string" + }, + { + "value": "secondary", + "type": "string" + }, + { + "value": "success", + "type": "string" + }, + { + "value": "warning", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "disabled", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "disabled", + "reflectToAttr": false, + "docs": "Specifies that the button should be disabled. A disabled button is unusable\nand un-clickable. Corresponds with the native HTML disabled attribute.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "icon", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "icon", + "reflectToAttr": false, + "docs": "The name of an icon to be displayed in the button.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "iconOnly", + "type": "\"l\" | \"m\" | \"s\" | \"xl\" | \"xs\" | boolean", + "complexType": { + "original": "boolean | Breakpoint", + "resolved": "\"l\" | \"m\" | \"s\" | \"xl\" | \"xs\" | boolean", + "references": { + "Breakpoint": { + "location": "import", + "path": "../../utils/breakpoints", + "id": "src/utils/breakpoints.ts::Breakpoint" + } + } + }, + "mutable": false, + "attr": "icon-only", + "reflectToAttr": false, + "docs": "Hide the actual button content and only display the icon.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "value": "l", + "type": "string" + }, + { + "value": "m", + "type": "string" + }, + { + "value": "s", + "type": "string" + }, + { + "value": "xl", + "type": "string" + }, + { + "value": "xs", + "type": "string" + }, + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "iconRight", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "icon-right", + "reflectToAttr": false, + "docs": "Display the icon on the right.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "loading", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "loading", + "reflectToAttr": false, + "docs": "Displays the button in a loading state with a spinner. Just like a disabled\nbutton, an inactive button is unusable and un-clickable. However, it\nretains the current focus state.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "name", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "name", + "reflectToAttr": false, + "docs": "The name of the button, which gets paired with the button's value when\nsubmitted as part of a form. Corresponds with the native HTML name\nattribute.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "nativeAttributes", + "type": "undefined | { [key: string]: string; }", + "complexType": { + "original": "{ [key: string]: string }", + "resolved": "undefined | { [key: string]: string; }", + "references": {} + }, + "mutable": false, + "reflectToAttr": false, + "docs": "Attributes that will be added to the native HTML button element", + "docsTags": [], + "values": [ + { + "type": "undefined" + }, + { + "type": "{ [key: string]: string; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "nativeContentAttributes", + "type": "undefined | { [key: string]: string; }", + "complexType": { + "original": "{ [key: string]: string }", + "resolved": "undefined | { [key: string]: string; }", + "references": {} + }, + "mutable": false, + "reflectToAttr": false, + "docs": "Attributes that will be added to the native HTML button content element", + "docsTags": [], + "values": [ + { + "type": "undefined" + }, + { + "type": "{ [key: string]: string; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "noEllipsis", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "no-ellipsis", + "reflectToAttr": false, + "docs": "Disables ellipse overflowing button content.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "round", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "round", + "reflectToAttr": false, + "docs": "Use round button edges.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "size", + "type": "\"l\" | \"m\" | \"s\" | \"xl\" | \"xs\"", + "complexType": { + "original": "'xs' | 's' | 'm' | 'l' | 'xl'", + "resolved": "\"l\" | \"m\" | \"s\" | \"xl\" | \"xs\"", + "references": {} + }, + "mutable": false, + "attr": "size", + "reflectToAttr": false, + "docs": "The size of the button.", + "docsTags": [ + { + "name": "default", + "text": "'m'" + } + ], + "default": "'m'", + "values": [ + { + "value": "l", + "type": "string" + }, + { + "value": "m", + "type": "string" + }, + { + "value": "s", + "type": "string" + }, + { + "value": "xl", + "type": "string" + }, + { + "value": "xs", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "submit", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "submit", + "reflectToAttr": false, + "docs": "Allows the button to submit a form.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "testId", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "test-id", + "reflectToAttr": false, + "docs": "A unique identifier for the underlying native element that is used for\ntesting purposes. The attribute is added as `data-test` attribute and acts\nas a shorthand for `nativeAttributes={ 'data-test': 'test-Id' }`.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "url", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "url", + "reflectToAttr": false, + "docs": "A destination to link to, rendered in the href attribute of a link.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "urlTarget", + "type": "\"_blank\" | \"_self\" | undefined", + "complexType": { + "original": "'_blank' | '_self'", + "resolved": "\"_blank\" | \"_self\" | undefined", + "references": {} + }, + "mutable": false, + "attr": "url-target", + "reflectToAttr": false, + "docs": "Specifies where to open the linked document.", + "docsTags": [], + "values": [ + { + "value": "_blank", + "type": "string" + }, + { + "value": "_self", + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "value", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "value", + "reflectToAttr": false, + "docs": "The value of the button, which gets paired with the button's name when\nsubmitted as part of a form. Corresponds with the native HTML value\nattribute.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "variant", + "type": "\"filled\" | \"link\" | \"outlined\" | \"text\"", + "complexType": { + "original": "'filled' | 'outlined' | 'text' | 'link'", + "resolved": "\"filled\" | \"link\" | \"outlined\" | \"text\"", + "references": {} + }, + "mutable": false, + "attr": "variant", + "reflectToAttr": false, + "docs": "The rendering style of the button.", + "docsTags": [ + { + "name": "default", + "text": "'outlined'" + } + ], + "default": "'outlined'", + "values": [ + { + "value": "filled", + "type": "string" + }, + { + "value": "link", + "type": "string" + }, + { + "value": "outlined", + "type": "string" + }, + { + "value": "text", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [ + { + "name": "doBlur", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "doBlur() => Promise", + "parameters": [], + "docs": "Programmatically remove focus from the button. Use this method instead of\n`button.blur()`.", + "docsTags": [] + }, + { + "name": "doClick", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "doClick() => Promise", + "parameters": [], + "docs": "Programmatically simulate a click on the button.", + "docsTags": [] + }, + { + "name": "doFocus", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + }, + "FocusOptions": { + "location": "global", + "id": "global::FocusOptions" + } + }, + "return": "Promise" + }, + "signature": "doFocus(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "docs": "Programmatically move focus to the button. Use this method instead of\n`button.focus()`.", + "docsTags": [ + { + "name": "param", + "text": "options An optional object providing options to control aspects of\nthe focusing process." + } + ] + } + ], + "events": [ + { + "event": "catBlur", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the button loses focus.", + "docsTags": [] + }, + { + "event": "catClick", + "detail": "MouseEvent", + "bubbles": true, + "complexType": { + "original": "MouseEvent", + "resolved": "MouseEvent", + "references": { + "MouseEvent": { + "location": "global", + "id": "global::MouseEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the button is clicked.", + "docsTags": [] + }, + { + "event": "catFocus", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the button received focus.", + "docsTags": [] + } + ], + "styles": [], + "slots": [], + "parts": [ + { + "name": "button", + "docs": "The native anchor or button element." + }, + { + "name": "content", + "docs": "The textual content of the button." + }, + { + "name": "prefix", + "docs": "The prefix icon." + }, + { + "name": "suffix", + "docs": "The suffix icon." + } + ], + "listeners": [ + { + "event": "click", + "capture": false, + "passive": false + } + ] +} \ No newline at end of file diff --git a/core/src/components/cat-card/docs.json b/core/src/components/cat-card/docs.json new file mode 100644 index 000000000..e731b00a0 --- /dev/null +++ b/core/src/components/cat-card/docs.json @@ -0,0 +1,44 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-card", + "filePath": "src/components/cat-card/cat-card.tsx", + "fileName": "cat-card.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-card/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-card/usage", + "tag": "cat-card", + "readme": "# cat-card\n\n\n", + "overview": "Cards are surfaces that display content and actions on a single topic. They\nshould be easy to scan for relevant and actionable information.", + "usage": {}, + "docs": "Cards are surfaces that display content and actions on a single topic. They\nshould be easy to scan for relevant and actionable information.", + "docsTags": [], + "encapsulation": "shadow", + "dependents": [], + "dependencies": [], + "dependencyGraph": {}, + "props": [], + "methods": [], + "events": [ + { + "event": "catLoad", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the card and all the children are fully loaded.", + "docsTags": [] + } + ], + "styles": [], + "slots": [], + "parts": [], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-checkbox/docs.json b/core/src/components/cat-checkbox/docs.json new file mode 100644 index 000000000..3853e7738 --- /dev/null +++ b/core/src/components/cat-checkbox/docs.json @@ -0,0 +1,686 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-checkbox", + "filePath": "src/components/cat-checkbox/cat-checkbox.tsx", + "fileName": "cat-checkbox.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-checkbox/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-checkbox/usage", + "tag": "cat-checkbox", + "readme": "# cat-checkbox\n\n\n", + "overview": "Checkboxes are used to let a user choose one or more options from a limited\nnumber of options.", + "usage": {}, + "docs": "Checkboxes are used to let a user choose one or more options from a limited\nnumber of options.", + "docsTags": [ + { + "name": "slot", + "text": "hint - Optional hint element to be displayed with the checkbox." + }, + { + "name": "slot", + "text": "label - The slotted label. If both the label property and the label slot are present, only the label slot will be displayed." + }, + { + "name": "part", + "text": "label - The label content." + }, + { + "name": "part", + "text": "input - The native input element." + } + ], + "encapsulation": "shadow", + "dependents": [ + "cat-select" + ], + "dependencies": [], + "dependencyGraph": { + "cat-select": [ + "cat-checkbox" + ] + }, + "props": [ + { + "name": "alignment", + "type": "\"bottom\" | \"center\" | \"top\"", + "complexType": { + "original": "'center' | 'top' | 'bottom'", + "resolved": "\"bottom\" | \"center\" | \"top\"", + "references": {} + }, + "mutable": false, + "attr": "alignment", + "reflectToAttr": false, + "docs": "The alignment of the checkbox.", + "docsTags": [ + { + "name": "default", + "text": "'top'" + } + ], + "default": "'top'", + "values": [ + { + "value": "bottom", + "type": "string" + }, + { + "value": "center", + "type": "string" + }, + { + "value": "top", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "checked", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": true, + "attr": "checked", + "reflectToAttr": false, + "docs": "Checked state of the checkbox", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "disabled", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "disabled", + "reflectToAttr": false, + "docs": "Disabled state of the checkbox", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "hint", + "type": "string | string[] | undefined", + "complexType": { + "original": "string | string[]", + "resolved": "string | string[] | undefined", + "references": {} + }, + "mutable": false, + "attr": "hint", + "reflectToAttr": false, + "docs": "Optional hint text(s) to be displayed with the checkbox.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "string[]" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "identifier", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "identifier", + "reflectToAttr": false, + "docs": "A unique identifier for the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "indeterminate", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": true, + "attr": "indeterminate", + "reflectToAttr": false, + "docs": "Indeterminate state of the checkbox", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "label", + "type": "string", + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "mutable": false, + "attr": "label", + "reflectToAttr": false, + "docs": "Label of the checkbox which is presented in the UI", + "docsTags": [ + { + "name": "default", + "text": "''" + } + ], + "default": "''", + "values": [ + { + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "labelHidden", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "label-hidden", + "reflectToAttr": false, + "docs": "Visually hide the label, but still show it to assistive technologies like screen readers.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "labelLeft", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "label-left", + "reflectToAttr": false, + "docs": "Whether the label should appear to the left of the checkbox.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "name", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "name", + "reflectToAttr": false, + "docs": "The name of the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "nativeAttributes", + "type": "undefined | { [key: string]: string; }", + "complexType": { + "original": "{ [key: string]: string }", + "resolved": "undefined | { [key: string]: string; }", + "references": {} + }, + "mutable": false, + "reflectToAttr": false, + "docs": "Attributes that will be added to the native HTML input element.", + "docsTags": [], + "values": [ + { + "type": "undefined" + }, + { + "type": "{ [key: string]: string; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "noValue", + "type": "any", + "complexType": { + "original": "any", + "resolved": "any", + "references": {} + }, + "mutable": false, + "attr": "no-value", + "reflectToAttr": false, + "docs": "The value of the unchecked checkbox.", + "docsTags": [], + "values": [ + { + "type": "any" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "required", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "required", + "reflectToAttr": false, + "docs": "Required state of the checkbox.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "requiredMarker", + "type": "\"none!\" | \"none\" | \"optional!\" | \"optional\" | \"required!\" | \"required\" | undefined", + "complexType": { + "original": "'none' | 'required' | 'optional' | 'none!' | 'optional!' | 'required!'", + "resolved": "\"none!\" | \"none\" | \"optional!\" | \"optional\" | \"required!\" | \"required\" | undefined", + "references": {} + }, + "mutable": false, + "attr": "required-marker", + "reflectToAttr": false, + "docs": "Whether the label need a marker to shown if the input is required or optional.", + "docsTags": [ + { + "name": "default", + "text": "'none'" + } + ], + "default": "'none'", + "values": [ + { + "value": "none!", + "type": "string" + }, + { + "value": "none", + "type": "string" + }, + { + "value": "optional!", + "type": "string" + }, + { + "value": "optional", + "type": "string" + }, + { + "value": "required!", + "type": "string" + }, + { + "value": "required", + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "resolvedValue", + "type": "any", + "complexType": { + "original": "any", + "resolved": "any", + "references": {} + }, + "mutable": true, + "attr": "resolved-value", + "reflectToAttr": false, + "docs": "The resolved value of the checkbox, based on the checked state and value.", + "docsTags": [ + { + "name": "default", + "text": "null" + } + ], + "default": "null", + "values": [ + { + "type": "any" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "testId", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "test-id", + "reflectToAttr": false, + "docs": "A unique identifier for the underlying native element that is used for\ntesting purposes. The attribute is added as `data-test` attribute and acts\nas a shorthand for `nativeAttributes={ 'data-test': 'test-Id' }`.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "value", + "type": "any", + "complexType": { + "original": "any", + "resolved": "any", + "references": {} + }, + "mutable": false, + "attr": "value", + "reflectToAttr": false, + "docs": "The value of the checked checkbox.", + "docsTags": [], + "values": [ + { + "type": "any" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [ + { + "name": "doBlur", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "doBlur() => Promise", + "parameters": [], + "docs": "Programmatically remove focus from the checkbox. Use this method instead of\n`input.blur()`.", + "docsTags": [] + }, + { + "name": "doFocus", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + }, + "FocusOptions": { + "location": "global", + "id": "global::FocusOptions" + } + }, + "return": "Promise" + }, + "signature": "doFocus(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "docs": "Programmatically move focus to the checkbox. Use this method instead of\n`input.focus()`.", + "docsTags": [ + { + "name": "param", + "text": "options An optional object providing options to control aspects of\nthe focusing process." + } + ] + } + ], + "events": [ + { + "event": "catBlur", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the checkbox loses focus.", + "docsTags": [] + }, + { + "event": "catChange", + "detail": "any", + "bubbles": true, + "complexType": { + "original": "any", + "resolved": "any", + "references": {} + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the checked status of the checkbox is changed.", + "docsTags": [] + }, + { + "event": "catFocus", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the checkbox received focus.", + "docsTags": [] + } + ], + "styles": [], + "slots": [ + { + "name": "hint", + "docs": "Optional hint element to be displayed with the checkbox." + }, + { + "name": "label", + "docs": "The slotted label. If both the label property and the label slot are present, only the label slot will be displayed." + } + ], + "parts": [ + { + "name": "input", + "docs": "The native input element." + }, + { + "name": "label", + "docs": "The label content." + } + ], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-date-inline/docs.json b/core/src/components/cat-date-inline/docs.json new file mode 100644 index 000000000..89cdaa167 --- /dev/null +++ b/core/src/components/cat-date-inline/docs.json @@ -0,0 +1,617 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-date-inline", + "filePath": "src/components/cat-date-inline/cat-date-inline.tsx", + "fileName": "cat-date-inline.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-date-inline/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-date-inline/usage", + "tag": "cat-date-inline", + "readme": "# cat-date-inline\n\n\n", + "overview": "An inline date picker component to select a date.", + "usage": {}, + "docs": "An inline date picker component to select a date.", + "docsTags": [ + { + "name": "part", + "text": "label - The native label element." + } + ], + "encapsulation": "shadow", + "dependents": [ + "cat-date" + ], + "dependencies": [ + "cat-button" + ], + "dependencyGraph": { + "cat-date-inline": [ + "cat-button" + ], + "cat-button": [ + "cat-icon", + "cat-spinner" + ], + "cat-date": [ + "cat-date-inline" + ] + }, + "props": [ + { + "name": "a11yLabel", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "a11y-label", + "reflectToAttr": false, + "docs": "Adds accessible label for the datepicker. The label will be read by\nassistive technology upon focusing the datepicker.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "hint", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "hint", + "reflectToAttr": false, + "docs": "Shows an arrow keys navigation hint.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "identifier", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "identifier", + "reflectToAttr": false, + "docs": "A unique identifier for the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "label", + "type": "string", + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "mutable": false, + "attr": "label", + "reflectToAttr": false, + "docs": "The label for the input.", + "docsTags": [ + { + "name": "default", + "text": "''" + } + ], + "default": "''", + "values": [ + { + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "labelHidden", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "label-hidden", + "reflectToAttr": false, + "docs": "Visually hide the label, but still show it to assistive technologies like screen readers.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "max", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "max", + "reflectToAttr": false, + "docs": "A maximum value for the date, given in local ISO 8601 date format YYYY-MM-DD.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "min", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "min", + "reflectToAttr": false, + "docs": "A minimum value for the date, given in local ISO 8601 date format YYYY-MM-DD.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "noClear", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "no-clear", + "reflectToAttr": false, + "docs": "Hides the clear button.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "noToday", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "no-today", + "reflectToAttr": false, + "docs": "Hides the today button.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "range", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "range", + "reflectToAttr": false, + "docs": "Allow the selection of a range of dates, i.e. start and end date.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "required", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "required", + "reflectToAttr": false, + "docs": "A value is required or must be check for the form to be submittable.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "requiredMarker", + "type": "\"none!\" | \"none\" | \"optional!\" | \"optional\" | \"required!\" | \"required\" | undefined", + "complexType": { + "original": "'none' | 'required' | 'optional' | 'none!' | 'optional!' | 'required!'", + "resolved": "\"none!\" | \"none\" | \"optional!\" | \"optional\" | \"required!\" | \"required\" | undefined", + "references": {} + }, + "mutable": false, + "attr": "required-marker", + "reflectToAttr": false, + "docs": "Whether the label need a marker to shown if the input is required or optional.", + "docsTags": [ + { + "name": "default", + "text": "'optional'" + } + ], + "default": "'optional'", + "values": [ + { + "value": "none!", + "type": "string" + }, + { + "value": "none", + "type": "string" + }, + { + "value": "optional!", + "type": "string" + }, + { + "value": "optional", + "type": "string" + }, + { + "value": "required!", + "type": "string" + }, + { + "value": "required", + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "value", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": true, + "attr": "value", + "reflectToAttr": false, + "docs": "The value of the control, given in local ISO 8601 date format YYYY-MM-DD.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "weeks", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "weeks", + "reflectToAttr": false, + "docs": "Show week numbers.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [ + { + "name": "clear", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "clear() => Promise", + "parameters": [], + "docs": "Clear the picker.", + "docsTags": [] + }, + { + "name": "doFocus", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + }, + "FocusOptions": { + "location": "global", + "id": "global::FocusOptions" + } + }, + "return": "Promise" + }, + "signature": "doFocus(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "docs": "Programmatically move focus to the inline datepicker, i,e, the first\nfocusable date.", + "docsTags": [ + { + "name": "param", + "text": "options An optional object providing options to control aspects of\nthe focusing process." + } + ] + }, + { + "name": "resetView", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "resetView() => Promise", + "parameters": [], + "docs": "Resets the view of the picker.", + "docsTags": [] + }, + { + "name": "select", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "(date: Date | null) => Promise", + "parameters": [ + { + "name": "date", + "type": "Date | null", + "docs": "The date to select." + } + ], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + }, + "Date": { + "location": "global", + "id": "global::Date" + } + }, + "return": "Promise" + }, + "signature": "select(date: Date | null) => Promise", + "parameters": [ + { + "name": "date", + "type": "Date | null", + "docs": "The date to select." + } + ], + "docs": "Select a date in the picker.", + "docsTags": [ + { + "name": "param", + "text": "date The date to select." + } + ] + } + ], + "events": [ + { + "event": "catChange", + "detail": "string", + "bubbles": true, + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the value is changed.", + "docsTags": [] + } + ], + "styles": [], + "slots": [], + "parts": [ + { + "name": "label", + "docs": "The native label element." + } + ], + "listeners": [ + { + "event": "keydown", + "capture": false, + "passive": false + } + ] +} \ No newline at end of file diff --git a/core/src/components/cat-date/docs.json b/core/src/components/cat-date/docs.json new file mode 100644 index 000000000..383385370 --- /dev/null +++ b/core/src/components/cat-date/docs.json @@ -0,0 +1,965 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-date", + "filePath": "src/components/cat-date/cat-date.tsx", + "fileName": "cat-date.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-date/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-date/usage", + "tag": "cat-date", + "readme": "# cat-date\n\n\n", + "overview": "A date input component to select a date from a calendar in a dropdown.", + "usage": {}, + "docs": "A date input component to select a date from a calendar in a dropdown.", + "docsTags": [], + "encapsulation": "shadow", + "dependents": [], + "dependencies": [ + "cat-input", + "cat-dropdown", + "cat-button", + "cat-date-inline" + ], + "dependencyGraph": { + "cat-date": [ + "cat-input", + "cat-dropdown", + "cat-button", + "cat-date-inline" + ], + "cat-input": [ + "cat-icon", + "cat-button", + "cat-spinner" + ], + "cat-button": [ + "cat-icon", + "cat-spinner" + ], + "cat-date-inline": [ + "cat-button" + ] + }, + "props": [ + { + "name": "autoComplete", + "type": "string", + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "mutable": false, + "attr": "auto-complete", + "reflectToAttr": false, + "docs": "Hint for form autofill feature.", + "docsTags": [ + { + "name": "default", + "text": "'off'" + } + ], + "default": "'off'", + "values": [ + { + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "clearable", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "clearable", + "reflectToAttr": false, + "docs": "Whether the input should show a clear button.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "disabled", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "disabled", + "reflectToAttr": false, + "docs": "Whether the input is disabled.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "errorUpdate", + "type": "boolean | number", + "complexType": { + "original": "boolean | number", + "resolved": "boolean | number", + "references": {} + }, + "mutable": false, + "attr": "error-update", + "reflectToAttr": false, + "docs": "Fine-grained control over when the errors are shown. Can be `false` to\nnever show errors, `true` to show errors on blur, or a number to show\nerrors change with the given delay in milliseconds or immediately on blur.", + "docsTags": [ + { + "name": "default", + "text": "0" + } + ], + "default": "0", + "values": [ + { + "type": "boolean" + }, + { + "type": "number" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "errors", + "type": "boolean | string[] | undefined | { [key: string]: any; }", + "complexType": { + "original": "boolean | string[] | ErrorMap", + "resolved": "boolean | string[] | undefined | { [key: string]: any; }", + "references": { + "ErrorMap": { + "location": "import", + "path": "../cat-form-hint/cat-form-hint", + "id": "src/components/cat-form-hint/cat-form-hint.tsx::ErrorMap" + } + } + }, + "mutable": false, + "attr": "errors", + "reflectToAttr": false, + "docs": "The validation errors for this input. Will render a hint under the input\nwith the translated error message(s) `error.${key}`. If an object is\npassed, the keys will be used as error keys and the values translation\nparameters.\nIf the value is `true`, the input will be marked as invalid without any\nhints under the input.", + "docsTags": [], + "values": [ + { + "type": "boolean" + }, + { + "type": "string[]" + }, + { + "type": "undefined" + }, + { + "type": "{ [key: string]: any; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "hint", + "type": "string | string[] | undefined", + "complexType": { + "original": "string | string[]", + "resolved": "string | string[] | undefined", + "references": {} + }, + "mutable": false, + "attr": "hint", + "reflectToAttr": false, + "docs": "Optional hint text(s) to be displayed with the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "string[]" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "horizontal", + "type": "boolean | undefined", + "complexType": { + "original": "boolean", + "resolved": "boolean | undefined", + "references": {} + }, + "mutable": false, + "attr": "horizontal", + "reflectToAttr": false, + "docs": "Whether the label is on top or left.", + "docsTags": [], + "values": [ + { + "type": "boolean" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "icon", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "icon", + "reflectToAttr": false, + "docs": "The name of an icon to be displayed in the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "iconRight", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "icon-right", + "reflectToAttr": false, + "docs": "Display the icon on the right.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "identifier", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "identifier", + "reflectToAttr": false, + "docs": "A unique identifier for the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "label", + "type": "string", + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "mutable": false, + "attr": "label", + "reflectToAttr": false, + "docs": "The label for the input.", + "docsTags": [ + { + "name": "default", + "text": "''" + } + ], + "default": "''", + "values": [ + { + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "labelHidden", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "label-hidden", + "reflectToAttr": false, + "docs": "Visually hide the label, but still show it to assistive technologies like screen readers.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "max", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "max", + "reflectToAttr": false, + "docs": "A maximum value for the date, given in local ISO 8601 date format YYYY-MM-DD.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "min", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "min", + "reflectToAttr": false, + "docs": "A minimum value for the date, given in local ISO 8601 date format YYYY-MM-DD.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "name", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "name", + "reflectToAttr": false, + "docs": "The name of the form control. Submitted with the form as part of a name/value pair.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "nativeAttributes", + "type": "undefined | { [key: string]: string; }", + "complexType": { + "original": "{ [key: string]: string }", + "resolved": "undefined | { [key: string]: string; }", + "references": {} + }, + "mutable": false, + "reflectToAttr": false, + "docs": "Attributes that will be added to the native HTML input element.", + "docsTags": [], + "values": [ + { + "type": "undefined" + }, + { + "type": "{ [key: string]: string; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "placeholder", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "placeholder", + "reflectToAttr": false, + "docs": "The placeholder text to display within the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "placement", + "type": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\"", + "complexType": { + "original": "Placement", + "resolved": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\"", + "references": { + "Placement": { + "location": "import", + "path": "@floating-ui/dom", + "id": "../node_modules/.pnpm/@floating-ui+dom@1.6.13/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement" + } + } + }, + "mutable": false, + "attr": "placement", + "reflectToAttr": false, + "docs": "The placement of the dropdown.", + "docsTags": [ + { + "name": "default", + "text": "'bottom-end'" + } + ], + "default": "'bottom-end'", + "values": [ + { + "value": "bottom", + "type": "string" + }, + { + "value": "bottom-end", + "type": "string" + }, + { + "value": "bottom-start", + "type": "string" + }, + { + "value": "left", + "type": "string" + }, + { + "value": "left-end", + "type": "string" + }, + { + "value": "left-start", + "type": "string" + }, + { + "value": "right", + "type": "string" + }, + { + "value": "right-end", + "type": "string" + }, + { + "value": "right-start", + "type": "string" + }, + { + "value": "top", + "type": "string" + }, + { + "value": "top-end", + "type": "string" + }, + { + "value": "top-start", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "readonly", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "readonly", + "reflectToAttr": false, + "docs": "The value is not editable.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "required", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "required", + "reflectToAttr": false, + "docs": "A value is required or must be check for the form to be submittable.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "requiredMarker", + "type": "\"none!\" | \"none\" | \"optional!\" | \"optional\" | \"required!\" | \"required\" | undefined", + "complexType": { + "original": "'none' | 'required' | 'optional' | 'none!' | 'optional!' | 'required!'", + "resolved": "\"none!\" | \"none\" | \"optional!\" | \"optional\" | \"required!\" | \"required\" | undefined", + "references": {} + }, + "mutable": false, + "attr": "required-marker", + "reflectToAttr": false, + "docs": "Whether the label need a marker to shown if the input is required or optional.", + "docsTags": [ + { + "name": "default", + "text": "'optional'" + } + ], + "default": "'optional'", + "values": [ + { + "value": "none!", + "type": "string" + }, + { + "value": "none", + "type": "string" + }, + { + "value": "optional!", + "type": "string" + }, + { + "value": "optional", + "type": "string" + }, + { + "value": "required!", + "type": "string" + }, + { + "value": "required", + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "testId", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "test-id", + "reflectToAttr": false, + "docs": "A unique identifier for the underlying native element that is used for\ntesting purposes. The attribute is added as `data-test` attribute and acts\nas a shorthand for `nativeAttributes={ 'data-test': 'test-Id' }`.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "textPrefix", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "text-prefix", + "reflectToAttr": false, + "docs": "A textual prefix to be displayed in the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "textSuffix", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "text-suffix", + "reflectToAttr": false, + "docs": "A textual suffix to be displayed in the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "value", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": true, + "attr": "value", + "reflectToAttr": false, + "docs": "The value of the control, given in local ISO 8601 date format YYYY-MM-DD.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [ + { + "name": "clear", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "clear() => Promise", + "parameters": [], + "docs": "Clear the input.", + "docsTags": [] + }, + { + "name": "doBlur", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "doBlur() => Promise", + "parameters": [], + "docs": "Programmatically remove focus from the input. Use this method instead of\n`input.blur()`.", + "docsTags": [] + }, + { + "name": "doFocus", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + }, + "FocusOptions": { + "location": "global", + "id": "global::FocusOptions" + } + }, + "return": "Promise" + }, + "signature": "doFocus(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "docs": "Programmatically move focus to the input. Use this method instead of\n`input.focus()`.", + "docsTags": [ + { + "name": "param", + "text": "options An optional object providing options to control aspects of\nthe focusing process." + } + ] + } + ], + "events": [ + { + "event": "catBlur", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the input loses focus.", + "docsTags": [] + }, + { + "event": "catChange", + "detail": "string", + "bubbles": true, + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the value is changed.", + "docsTags": [] + }, + { + "event": "catFocus", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the input received focus.", + "docsTags": [] + } + ], + "styles": [], + "slots": [], + "parts": [], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-datepicker-inline/docs.json b/core/src/components/cat-datepicker-inline/docs.json new file mode 100644 index 000000000..40f2dc4d1 --- /dev/null +++ b/core/src/components/cat-datepicker-inline/docs.json @@ -0,0 +1,282 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-datepicker-inline", + "filePath": "src/components/cat-datepicker-inline/cat-datepicker-inline.tsx", + "fileName": "cat-datepicker-inline.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-datepicker-inline/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-datepicker-inline/usage", + "tag": "cat-datepicker-inline", + "readme": "# cat-datepicker-inline\n\n\n", + "overview": "", + "usage": {}, + "docs": "", + "docsTags": [], + "encapsulation": "shadow", + "dependents": [], + "dependencies": [], + "dependencyGraph": {}, + "props": [ + { + "name": "disabled", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "disabled", + "reflectToAttr": false, + "docs": "Whether the input is disabled.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "max", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "max", + "reflectToAttr": false, + "docs": "A maximum value as ISO Date string, e.g. 2017-03-04T01:23:43.000Z.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "min", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "min", + "reflectToAttr": false, + "docs": "A minimum value as ISO Date string, e.g. 2017-03-04T01:23:43.000Z.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "mode", + "type": "\"date\" | \"daterange\" | \"datetime\" | \"time\" | \"week\"", + "complexType": { + "original": "CatDatepickerMode", + "resolved": "\"date\" | \"daterange\" | \"datetime\" | \"time\" | \"week\"", + "references": { + "CatDatepickerMode": { + "location": "import", + "path": "../cat-datepicker/cat-datepicker.mode", + "id": "src/components/cat-datepicker/cat-datepicker.mode.ts::CatDatepickerMode" + } + } + }, + "mutable": false, + "attr": "mode", + "reflectToAttr": false, + "docs": "The mode of the datepicker, to select a date, time, both, a date range or a week number.", + "docsTags": [ + { + "name": "default", + "text": "'date'" + } + ], + "default": "'date'", + "values": [ + { + "value": "date", + "type": "string" + }, + { + "value": "daterange", + "type": "string" + }, + { + "value": "datetime", + "type": "string" + }, + { + "value": "time", + "type": "string" + }, + { + "value": "week", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "nativePickerAttributes", + "type": "undefined | { [key: string]: string; }", + "complexType": { + "original": "{ [key: string]: string }", + "resolved": "undefined | { [key: string]: string; }", + "references": {} + }, + "mutable": false, + "reflectToAttr": false, + "docs": "Attributes that will be added to the rendered HTML datepicker element.", + "docsTags": [], + "values": [ + { + "type": "undefined" + }, + { + "type": "{ [key: string]: string; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "readonly", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "readonly", + "reflectToAttr": false, + "docs": "The value is not editable.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "step", + "type": "number", + "complexType": { + "original": "number", + "resolved": "number", + "references": {} + }, + "mutable": false, + "attr": "step", + "reflectToAttr": false, + "docs": "The step size to use when changing the time.", + "docsTags": [ + { + "name": "default", + "text": "5" + } + ], + "default": "5", + "values": [ + { + "type": "number" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "value", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": true, + "attr": "value", + "reflectToAttr": false, + "docs": "The value as ISO Date string, e.g. 2017-03-04T01:23:43.000Z or as a week number string.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [], + "events": [ + { + "event": "catChange", + "detail": "string", + "bubbles": true, + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the value is changed.", + "docsTags": [] + } + ], + "styles": [], + "slots": [], + "parts": [], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-datepicker/docs.json b/core/src/components/cat-datepicker/docs.json new file mode 100644 index 000000000..036f5df47 --- /dev/null +++ b/core/src/components/cat-datepicker/docs.json @@ -0,0 +1,1059 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-datepicker", + "filePath": "src/components/cat-datepicker/cat-datepicker.tsx", + "fileName": "cat-datepicker.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-datepicker/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-datepicker/usage", + "tag": "cat-datepicker", + "readme": "# cat-datepicker\n\n\n", + "overview": "", + "usage": {}, + "docs": "", + "docsTags": [], + "encapsulation": "shadow", + "dependents": [], + "dependencies": [ + "cat-input" + ], + "dependencyGraph": { + "cat-datepicker": [ + "cat-input" + ], + "cat-input": [ + "cat-icon", + "cat-button", + "cat-spinner" + ], + "cat-button": [ + "cat-icon", + "cat-spinner" + ] + }, + "props": [ + { + "name": "attachToElement", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "attach-to-element", + "reflectToAttr": false, + "docs": "Instead of body, appends the calendar to the cat-datepicker element instead", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "autoComplete", + "type": "string", + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "mutable": false, + "attr": "auto-complete", + "reflectToAttr": false, + "docs": "Hint for form autofill feature.", + "docsTags": [ + { + "name": "default", + "text": "'off'" + } + ], + "default": "'off'", + "values": [ + { + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "clearable", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "clearable", + "reflectToAttr": false, + "docs": "Whether the input should show a clear button.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "disabled", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "disabled", + "reflectToAttr": false, + "docs": "Whether the input is disabled.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "errorUpdate", + "type": "boolean | number", + "complexType": { + "original": "boolean | number", + "resolved": "boolean | number", + "references": {} + }, + "mutable": false, + "attr": "error-update", + "reflectToAttr": false, + "docs": "Fine-grained control over when the errors are shown. Can be `false` to\nnever show errors, `true` to show errors on blur, or a number to show\nerrors change with the given delay in milliseconds or immediately on blur.", + "docsTags": [ + { + "name": "default", + "text": "0" + } + ], + "default": "0", + "values": [ + { + "type": "boolean" + }, + { + "type": "number" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "errors", + "type": "boolean | string[] | undefined | { [key: string]: any; }", + "complexType": { + "original": "boolean | string[] | ErrorMap", + "resolved": "boolean | string[] | undefined | { [key: string]: any; }", + "references": { + "ErrorMap": { + "location": "import", + "path": "../cat-form-hint/cat-form-hint", + "id": "src/components/cat-form-hint/cat-form-hint.tsx::ErrorMap" + } + } + }, + "mutable": false, + "attr": "errors", + "reflectToAttr": false, + "docs": "The validation errors for this input. Will render a hint under the input\nwith the translated error message(s) `error.${key}`. If an object is\npassed, the keys will be used as error keys and the values translation\nparameters.\nIf the value is `true`, the input will be marked as invalid without any\nhints under the input.", + "docsTags": [], + "values": [ + { + "type": "boolean" + }, + { + "type": "string[]" + }, + { + "type": "undefined" + }, + { + "type": "{ [key: string]: any; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "hint", + "type": "string | string[] | undefined", + "complexType": { + "original": "string | string[]", + "resolved": "string | string[] | undefined", + "references": {} + }, + "mutable": false, + "attr": "hint", + "reflectToAttr": false, + "docs": "Optional hint text(s) to be displayed with the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "string[]" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "horizontal", + "type": "boolean | undefined", + "complexType": { + "original": "boolean", + "resolved": "boolean | undefined", + "references": {} + }, + "mutable": false, + "attr": "horizontal", + "reflectToAttr": false, + "docs": "Whether the label is on top or left.", + "docsTags": [], + "values": [ + { + "type": "boolean" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "icon", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "icon", + "reflectToAttr": false, + "docs": "The name of an icon to be displayed in the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "iconRight", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "icon-right", + "reflectToAttr": false, + "docs": "Display the icon on the right.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "identifier", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "identifier", + "reflectToAttr": false, + "docs": "A unique identifier for the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "label", + "type": "string", + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "mutable": false, + "attr": "label", + "reflectToAttr": false, + "docs": "The label for the input.", + "docsTags": [ + { + "name": "default", + "text": "''" + } + ], + "default": "''", + "values": [ + { + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "labelHidden", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "label-hidden", + "reflectToAttr": false, + "docs": "Visually hide the label, but still show it to assistive technologies like screen readers.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "max", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "max", + "reflectToAttr": false, + "docs": "A maximum value as ISO Date string, e.g. 2017-03-04T01:23:43.000Z.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "min", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "min", + "reflectToAttr": false, + "docs": "A minimum value as ISO Date string, e.g. 2017-03-04T01:23:43.000Z.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "mode", + "type": "\"date\" | \"daterange\" | \"datetime\" | \"time\" | \"week\"", + "complexType": { + "original": "CatDatepickerMode", + "resolved": "\"date\" | \"daterange\" | \"datetime\" | \"time\" | \"week\"", + "references": { + "CatDatepickerMode": { + "location": "import", + "path": "./cat-datepicker.mode", + "id": "src/components/cat-datepicker/cat-datepicker.mode.ts::CatDatepickerMode" + } + } + }, + "mutable": false, + "attr": "mode", + "reflectToAttr": false, + "docs": "The mode of the datepicker, to select a date, time, both, a date range or a week number.", + "docsTags": [ + { + "name": "default", + "text": "'date'" + } + ], + "default": "'date'", + "values": [ + { + "value": "date", + "type": "string" + }, + { + "value": "daterange", + "type": "string" + }, + { + "value": "datetime", + "type": "string" + }, + { + "value": "time", + "type": "string" + }, + { + "value": "week", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "name", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "name", + "reflectToAttr": false, + "docs": "The name of the form control. Submitted with the form as part of a name/value pair.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "nativeAttributes", + "type": "undefined | { [key: string]: string; }", + "complexType": { + "original": "{ [key: string]: string }", + "resolved": "undefined | { [key: string]: string; }", + "references": {} + }, + "mutable": false, + "reflectToAttr": false, + "docs": "Attributes that will be added to the native HTML input element.", + "docsTags": [], + "values": [ + { + "type": "undefined" + }, + { + "type": "{ [key: string]: string; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "nativePickerAttributes", + "type": "undefined | { [key: string]: string; }", + "complexType": { + "original": "{ [key: string]: string }", + "resolved": "undefined | { [key: string]: string; }", + "references": {} + }, + "mutable": false, + "reflectToAttr": false, + "docs": "Attributes that will be added to the rendered HTML datepicker element.", + "docsTags": [], + "values": [ + { + "type": "undefined" + }, + { + "type": "{ [key: string]: string; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "placeholder", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "placeholder", + "reflectToAttr": false, + "docs": "The placeholder text to display within the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "position", + "type": "\"auto\" | Placement | \"above\" | \"below\" | \"auto left\" | \"auto center\" | \"auto right\" | \"above left\" | \"above center\" | \"above right\" | \"below left\" | \"below center\" | \"below right\" | ((self: Instance, customElement: HTMLElement | undefined) => void) | undefined", + "complexType": { + "original": "BaseOptions['position'] | Placement", + "resolved": "\"auto\" | Placement | \"above\" | \"below\" | \"auto left\" | \"auto center\" | \"auto right\" | \"above left\" | \"above center\" | \"above right\" | \"below left\" | \"below center\" | \"below right\" | ((self: Instance, customElement: HTMLElement | undefined) => void) | undefined", + "references": { + "BaseOptions": { + "location": "import", + "path": "flatpickr/dist/types/options", + "id": "../node_modules/.pnpm/flatpickr@4.6.13/node_modules/flatpickr/dist/types/options.d.ts::BaseOptions" + }, + "Placement": { + "location": "import", + "path": "@floating-ui/dom", + "id": "../node_modules/.pnpm/@floating-ui+dom@1.6.13/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement" + } + } + }, + "mutable": false, + "attr": "position", + "reflectToAttr": false, + "docs": "Where the calendar is rendered relative to the input vertically and horizontally.\nIn the format of \"[vertical] [horizontal]\". Vertical can be auto, above or below (required).\nHorizontal can be left, center or right.\nIf", + "docsTags": [ + { + "name": "attachToElement", + "text": "is passed the value should be in Placement format" + } + ], + "values": [ + { + "value": "auto", + "type": "string" + }, + { + "type": "Placement" + }, + { + "value": "above", + "type": "string" + }, + { + "value": "below", + "type": "string" + }, + { + "value": "auto left", + "type": "string" + }, + { + "value": "auto center", + "type": "string" + }, + { + "value": "auto right", + "type": "string" + }, + { + "value": "above left", + "type": "string" + }, + { + "value": "above center", + "type": "string" + }, + { + "value": "above right", + "type": "string" + }, + { + "value": "below left", + "type": "string" + }, + { + "value": "below center", + "type": "string" + }, + { + "value": "below right", + "type": "string" + }, + { + "type": "((self: Instance, customElement: HTMLElement" + }, + { + "type": "undefined) => void)" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "readonly", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "readonly", + "reflectToAttr": false, + "docs": "The value is not editable.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "required", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "required", + "reflectToAttr": false, + "docs": "A value is required or must be check for the form to be submittable.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "requiredMarker", + "type": "\"none!\" | \"none\" | \"optional!\" | \"optional\" | \"required!\" | \"required\" | undefined", + "complexType": { + "original": "'none' | 'required' | 'optional' | 'none!' | 'optional!' | 'required!'", + "resolved": "\"none!\" | \"none\" | \"optional!\" | \"optional\" | \"required!\" | \"required\" | undefined", + "references": {} + }, + "mutable": false, + "attr": "required-marker", + "reflectToAttr": false, + "docs": "Whether the label need a marker to shown if the input is required or optional.", + "docsTags": [ + { + "name": "default", + "text": "'optional'" + } + ], + "default": "'optional'", + "values": [ + { + "value": "none!", + "type": "string" + }, + { + "value": "none", + "type": "string" + }, + { + "value": "optional!", + "type": "string" + }, + { + "value": "optional", + "type": "string" + }, + { + "value": "required!", + "type": "string" + }, + { + "value": "required", + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "step", + "type": "number", + "complexType": { + "original": "number", + "resolved": "number", + "references": {} + }, + "mutable": false, + "attr": "step", + "reflectToAttr": false, + "docs": "The step size to use when changing the time.", + "docsTags": [ + { + "name": "default", + "text": "5" + } + ], + "default": "5", + "values": [ + { + "type": "number" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "textPrefix", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "text-prefix", + "reflectToAttr": false, + "docs": "A textual prefix to be displayed in the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "textSuffix", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "text-suffix", + "reflectToAttr": false, + "docs": "A textual suffix to be displayed in the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "value", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": true, + "attr": "value", + "reflectToAttr": false, + "docs": "The value as ISO Date string, e.g. 2017-03-04T01:23:43.000Z or as a week number string.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [ + { + "name": "doBlur", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "doBlur() => Promise", + "parameters": [], + "docs": "Programmatically remove focus from the datepicker. Use this method instead of\n`input.blur()`.", + "docsTags": [] + }, + { + "name": "doFocus", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + }, + "FocusOptions": { + "location": "global", + "id": "global::FocusOptions" + } + }, + "return": "Promise" + }, + "signature": "doFocus(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "docs": "Programmatically move focus to the datepicker. Use this method instead of\n`input.focus()`.", + "docsTags": [ + { + "name": "param", + "text": "options An optional object providing options to control aspects of\nthe focusing process." + } + ] + } + ], + "events": [ + { + "event": "catBlur", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the input loses focus.", + "docsTags": [] + }, + { + "event": "catChange", + "detail": "string", + "bubbles": true, + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the value is changed.", + "docsTags": [] + }, + { + "event": "catFocus", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the input received focus.", + "docsTags": [] + } + ], + "styles": [], + "slots": [], + "parts": [], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-dropdown/docs.json b/core/src/components/cat-dropdown/docs.json new file mode 100644 index 000000000..248402c64 --- /dev/null +++ b/core/src/components/cat-dropdown/docs.json @@ -0,0 +1,525 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-dropdown", + "filePath": "src/components/cat-dropdown/cat-dropdown.tsx", + "fileName": "cat-dropdown.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-dropdown/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-dropdown/usage", + "tag": "cat-dropdown", + "readme": "# cat-dropdown\n\n\n", + "overview": "A dropdown component to display a list of actions in a dropdown menu or to\nshow additional content on demand.", + "usage": {}, + "docs": "A dropdown component to display a list of actions in a dropdown menu or to\nshow additional content on demand.", + "docsTags": [], + "encapsulation": "shadow", + "dependents": [ + "cat-date", + "cat-select-demo", + "cat-tabs", + "cat-time" + ], + "dependencies": [], + "dependencyGraph": { + "cat-date": [ + "cat-dropdown" + ], + "cat-select-demo": [ + "cat-dropdown" + ], + "cat-tabs": [ + "cat-dropdown" + ], + "cat-time": [ + "cat-dropdown" + ] + }, + "props": [ + { + "name": "arrowNavigation", + "type": "\"horizontal\" | \"none\" | \"vertical\"", + "complexType": { + "original": "'horizontal' | 'vertical' | 'none'", + "resolved": "\"horizontal\" | \"none\" | \"vertical\"", + "references": {} + }, + "mutable": false, + "attr": "arrow-navigation", + "reflectToAttr": false, + "docs": "Do not navigate focus inside the dropdown via vertical arrow keys.", + "docsTags": [ + { + "name": "default", + "text": "'vertical'" + } + ], + "default": "'vertical'", + "values": [ + { + "value": "horizontal", + "type": "string" + }, + { + "value": "none", + "type": "string" + }, + { + "value": "vertical", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "delayedTriggerInit", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "delayed-trigger-init", + "reflectToAttr": false, + "docs": "Whether the dropdown trigger should be initialized only before first opening.\nCan be useful when trigger is rendered dynamically.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "isOpen", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "is-open", + "reflectToAttr": false, + "docs": "Whether the dropdown is open.", + "docsTags": [ + { + "name": "readonly" + } + ], + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": true, + "setter": false + }, + { + "name": "justify", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "justify", + "reflectToAttr": false, + "docs": "Make the dropdown match the width of the reference regardless of its\ncontents. Note that this only applies to the minimum width of the\ndropdown. The maximum width is still limited by the viewport.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "noAutoClose", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "no-auto-close", + "reflectToAttr": false, + "docs": "Do not close the dropdown on outside clicks.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "noInitialFocus", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "no-initial-focus", + "reflectToAttr": false, + "docs": "No element in dropdown will receive focus when dropdown is open.\nBy default, the first element in tab order will receive a focus.", + "docsTags": [ + { + "name": "deprecated", + "text": "Using noInitialFocus property would be a bad practice from a11y perspective.\nWe always want visible focus to jump inside the dropdown when user uses keyboard and noInitialFocus allows to turn it off which might introduce a bug.\nhasInitialFocus should resolve the cause of the original problem instead." + }, + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "deprecation": "Using noInitialFocus property would be a bad practice from a11y perspective.\nWe always want visible focus to jump inside the dropdown when user uses keyboard and noInitialFocus allows to turn it off which might introduce a bug.\nhasInitialFocus should resolve the cause of the original problem instead.", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "noResize", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "no-resize", + "reflectToAttr": false, + "docs": "Do not change the size of the dropdown to ensure it isn’t too big to fit\nin the viewport (or more specifically, its clipping context).", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "noReturnFocus", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "no-return-focus", + "reflectToAttr": false, + "docs": "Trigger element will not receive focus when dropdown is closed.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "overflow", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "overflow", + "reflectToAttr": false, + "docs": "Allow overflow when dropdown is open.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "placement", + "type": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\"", + "complexType": { + "original": "Placement", + "resolved": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\"", + "references": { + "Placement": { + "location": "import", + "path": "@floating-ui/dom", + "id": "../node_modules/.pnpm/@floating-ui+dom@1.6.13/node_modules/@floating-ui/dom/dist/floating-ui.dom.d.ts::Placement" + } + } + }, + "mutable": false, + "attr": "placement", + "reflectToAttr": false, + "docs": "The placement of the dropdown.", + "docsTags": [ + { + "name": "default", + "text": "'bottom-start'" + } + ], + "default": "'bottom-start'", + "values": [ + { + "value": "bottom", + "type": "string" + }, + { + "value": "bottom-end", + "type": "string" + }, + { + "value": "bottom-start", + "type": "string" + }, + { + "value": "left", + "type": "string" + }, + { + "value": "left-end", + "type": "string" + }, + { + "value": "left-start", + "type": "string" + }, + { + "value": "right", + "type": "string" + }, + { + "value": "right-end", + "type": "string" + }, + { + "value": "right-start", + "type": "string" + }, + { + "value": "top", + "type": "string" + }, + { + "value": "top-end", + "type": "string" + }, + { + "value": "top-start", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [ + { + "name": "close", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "close() => Promise", + "parameters": [], + "docs": "Closes the dropdown.", + "docsTags": [] + }, + { + "name": "open", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "(isFocusVisible?: boolean) => Promise", + "parameters": [ + { + "name": "isFocusVisible", + "type": "boolean | undefined", + "docs": "is dropdown should receive visible focus when it's opened." + } + ], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "open(isFocusVisible?: boolean) => Promise", + "parameters": [ + { + "name": "isFocusVisible", + "type": "boolean | undefined", + "docs": "is dropdown should receive visible focus when it's opened." + } + ], + "docs": "Opens the dropdown.", + "docsTags": [ + { + "name": "param", + "text": "isFocusVisible is dropdown should receive visible focus when it's opened." + } + ] + }, + { + "name": "toggle", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "toggle() => Promise", + "parameters": [], + "docs": "Toggles the dropdown.", + "docsTags": [] + } + ], + "events": [ + { + "event": "catClose", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the dropdown is closed.", + "docsTags": [] + }, + { + "event": "catOpen", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the dropdown is opened.", + "docsTags": [] + } + ], + "styles": [], + "slots": [], + "parts": [], + "listeners": [ + { + "event": "catClick", + "capture": false, + "passive": false + } + ] +} \ No newline at end of file diff --git a/core/src/components/cat-form-group/docs.json b/core/src/components/cat-form-group/docs.json new file mode 100644 index 000000000..5db6032e1 --- /dev/null +++ b/core/src/components/cat-form-group/docs.json @@ -0,0 +1,122 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-form-group", + "filePath": "src/components/cat-form-group/cat-form-group.tsx", + "fileName": "cat-form-group.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-form-group/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-form-group/usage", + "tag": "cat-form-group", + "readme": "# cat-form-group\n\n\n", + "overview": "A form group component to group form fields and labels.", + "usage": {}, + "docs": "A form group component to group form fields and labels.", + "docsTags": [], + "encapsulation": "shadow", + "dependents": [], + "dependencies": [], + "dependencyGraph": {}, + "props": [ + { + "name": "horizontal", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "horizontal", + "reflectToAttr": false, + "docs": "Whether the label is on top or left.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "labelSize", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "label-size", + "reflectToAttr": false, + "docs": "The space allocated to the input label", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "requiredMarker", + "type": "\"auto\" | \"none\" | \"optional\" | \"required\"", + "complexType": { + "original": "'none' | 'required' | 'optional' | 'auto'", + "resolved": "\"auto\" | \"none\" | \"optional\" | \"required\"", + "references": {} + }, + "mutable": false, + "attr": "required-marker", + "reflectToAttr": false, + "docs": "Whether the labels need a marker to shown if the forms fields are required or optional.

\nBy default, it is set to auto, it will display the mark depending on the number of required and optional fields:
\n- If there are more required, the optional will be marked.
\n- If there are less required, it will mark the required.

\nIf a form field had \"!\", the requiredMarked of the field would not change.", + "docsTags": [ + { + "name": "default", + "text": "'auto'" + } + ], + "default": "'auto'", + "values": [ + { + "value": "auto", + "type": "string" + }, + { + "value": "none", + "type": "string" + }, + { + "value": "optional", + "type": "string" + }, + { + "value": "required", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [], + "events": [], + "styles": [], + "slots": [], + "parts": [], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-icon/docs.json b/core/src/components/cat-icon/docs.json new file mode 100644 index 000000000..3ef8ee07b --- /dev/null +++ b/core/src/components/cat-icon/docs.json @@ -0,0 +1,203 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-icon", + "filePath": "src/components/cat-icon/cat-icon.tsx", + "fileName": "cat-icon.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-icon/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-icon/usage", + "tag": "cat-icon", + "readme": "# cat-icon\n", + "overview": "Icons are used to provide additional meaning or in places where text label\ndoesn't fit.", + "usage": {}, + "docs": "Icons are used to provide additional meaning or in places where text label\ndoesn't fit.", + "docsTags": [ + { + "name": "part", + "text": "icon - The span element wrapping the SVG icon." + } + ], + "encapsulation": "shadow", + "dependents": [ + "cat-alert", + "cat-avatar", + "cat-badge", + "cat-button", + "cat-input", + "cat-select", + "cat-tag", + "cat-textarea" + ], + "dependencies": [], + "dependencyGraph": { + "cat-alert": [ + "cat-icon" + ], + "cat-avatar": [ + "cat-icon" + ], + "cat-badge": [ + "cat-icon" + ], + "cat-button": [ + "cat-icon" + ], + "cat-input": [ + "cat-icon" + ], + "cat-select": [ + "cat-icon" + ], + "cat-tag": [ + "cat-icon" + ], + "cat-textarea": [ + "cat-icon" + ] + }, + "props": [ + { + "name": "a11yLabel", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "a11y-label", + "reflectToAttr": false, + "docs": "Adds accessible label for the icon that is only shown for screen\nreaders. The `aria-hidden` attribute will be set if no label is present.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "icon", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "icon", + "reflectToAttr": false, + "docs": "The name of the icon.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "iconSrc", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "icon-src", + "reflectToAttr": false, + "docs": "The SVG source of the icon. This takes precenedence over the `icon` name.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "size", + "type": "\"inline\" | \"l\" | \"m\" | \"s\" | \"xl\" | \"xs\"", + "complexType": { + "original": "'xs' | 's' | 'm' | 'l' | 'xl' | 'inline'", + "resolved": "\"inline\" | \"l\" | \"m\" | \"s\" | \"xl\" | \"xs\"", + "references": {} + }, + "mutable": false, + "attr": "size", + "reflectToAttr": false, + "docs": "The size of the icon.", + "docsTags": [ + { + "name": "default", + "text": "'m'" + } + ], + "default": "'m'", + "values": [ + { + "value": "inline", + "type": "string" + }, + { + "value": "l", + "type": "string" + }, + { + "value": "m", + "type": "string" + }, + { + "value": "s", + "type": "string" + }, + { + "value": "xl", + "type": "string" + }, + { + "value": "xs", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [], + "events": [], + "styles": [ + { + "name": "--cat-icon-ratio", + "annotation": "prop", + "docs": "The aspect ratio of the avatar." + } + ], + "slots": [], + "parts": [ + { + "name": "icon", + "docs": "The span element wrapping the SVG icon." + } + ], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-input/docs.json b/core/src/components/cat-input/docs.json new file mode 100644 index 000000000..bbb0c0727 --- /dev/null +++ b/core/src/components/cat-input/docs.json @@ -0,0 +1,1294 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-input", + "filePath": "src/components/cat-input/cat-input.tsx", + "fileName": "cat-input.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-input/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-input/usage", + "tag": "cat-input", + "readme": "# cat-input\n\n\n", + "overview": "Inputs are used to allow users to provide text input when the expected input\nis short. As well as plain text, Input supports various types of text,\nincluding passwords and numbers.", + "usage": {}, + "docs": "Inputs are used to allow users to provide text input when the expected input\nis short. As well as plain text, Input supports various types of text,\nincluding passwords and numbers.", + "docsTags": [ + { + "name": "slot", + "text": "hint - Optional hint element to be displayed with the input." + }, + { + "name": "slot", + "text": "label - The slotted label. If both the label property and the label slot are present, only the label slot will be displayed." + }, + { + "name": "slot", + "text": "counter - Custom counter element to be displayed in the top right corner of the label." + }, + { + "name": "part", + "text": "label - The native label element." + }, + { + "name": "part", + "text": "input - The native input element." + }, + { + "name": "part", + "text": "prefix - The text prefix." + }, + { + "name": "part", + "text": "suffix - The text suffix." + } + ], + "encapsulation": "shadow", + "dependents": [ + "cat-date", + "cat-datepicker", + "cat-time" + ], + "dependencies": [ + "cat-icon", + "cat-button", + "cat-spinner" + ], + "dependencyGraph": { + "cat-input": [ + "cat-icon", + "cat-button", + "cat-spinner" + ], + "cat-button": [ + "cat-icon", + "cat-spinner" + ], + "cat-date": [ + "cat-input" + ], + "cat-datepicker": [ + "cat-input" + ], + "cat-time": [ + "cat-input" + ] + }, + "props": [ + { + "name": "accept", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "accept", + "reflectToAttr": false, + "docs": "Defines the file types the file input should accept.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "autoComplete", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "auto-complete", + "reflectToAttr": false, + "docs": "Hint for form autofill feature.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "clearable", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "clearable", + "reflectToAttr": false, + "docs": "Whether the input should show a clear button.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "dateMaskOptions", + "type": "FormatDateMaskOptions | undefined", + "complexType": { + "original": "FormatDateMaskOptions", + "resolved": "FormatDateMaskOptions | undefined", + "references": { + "FormatDateMaskOptions": { + "location": "local", + "path": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-input/cat-input.tsx", + "id": "src/components/cat-input/cat-input.tsx::FormatDateMaskOptions" + } + } + }, + "mutable": false, + "reflectToAttr": false, + "docs": "Activates cleave-zen date mask on input", + "docsTags": [], + "values": [ + { + "type": "FormatDateMaskOptions" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "disabled", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "disabled", + "reflectToAttr": false, + "docs": "Whether the input is disabled.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "errorUpdate", + "type": "boolean | number", + "complexType": { + "original": "boolean | number", + "resolved": "boolean | number", + "references": {} + }, + "mutable": false, + "attr": "error-update", + "reflectToAttr": false, + "docs": "Fine-grained control over when the errors are shown. Can be `false` to\nnever show errors, `true` to show errors on blur, or a number to show\nerrors change with the given delay in milliseconds or immediately on blur.", + "docsTags": [ + { + "name": "default", + "text": "0" + } + ], + "default": "0", + "values": [ + { + "type": "boolean" + }, + { + "type": "number" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "errors", + "type": "boolean | string[] | undefined | { [key: string]: any; }", + "complexType": { + "original": "boolean | string[] | ErrorMap", + "resolved": "boolean | string[] | undefined | { [key: string]: any; }", + "references": { + "ErrorMap": { + "location": "import", + "path": "../cat-form-hint/cat-form-hint", + "id": "src/components/cat-form-hint/cat-form-hint.tsx::ErrorMap" + } + } + }, + "mutable": false, + "attr": "errors", + "reflectToAttr": false, + "docs": "The validation errors for this input. Will render a hint under the input\nwith the translated error message(s) `error.${key}`. If an object is\npassed, the keys will be used as error keys and the values translation\nparameters.\nIf the value is `true`, the input will be marked as invalid without any\nhints under the input.", + "docsTags": [], + "values": [ + { + "type": "boolean" + }, + { + "type": "string[]" + }, + { + "type": "undefined" + }, + { + "type": "{ [key: string]: any; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "hint", + "type": "string | string[] | undefined", + "complexType": { + "original": "string | string[]", + "resolved": "string | string[] | undefined", + "references": {} + }, + "mutable": false, + "attr": "hint", + "reflectToAttr": false, + "docs": "Optional hint text(s) to be displayed with the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "string[]" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "horizontal", + "type": "boolean | undefined", + "complexType": { + "original": "boolean", + "resolved": "boolean | undefined", + "references": {} + }, + "mutable": false, + "attr": "horizontal", + "reflectToAttr": false, + "docs": "Whether the label is on top or left.", + "docsTags": [], + "values": [ + { + "type": "boolean" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "icon", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "icon", + "reflectToAttr": false, + "docs": "The name of an icon to be displayed in the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "iconRight", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "icon-right", + "reflectToAttr": false, + "docs": "Display the icon on the right.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "identifier", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "identifier", + "reflectToAttr": false, + "docs": "A unique identifier for the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "label", + "type": "string", + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "mutable": false, + "attr": "label", + "reflectToAttr": false, + "docs": "The label for the input.", + "docsTags": [ + { + "name": "default", + "text": "''" + } + ], + "default": "''", + "values": [ + { + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "labelHidden", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "label-hidden", + "reflectToAttr": false, + "docs": "Visually hide the label, but still show it to assistive technologies like screen readers.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "loading", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "loading", + "reflectToAttr": false, + "docs": "Displays the input in a loading state with a spinner.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "max", + "type": "number | string | undefined", + "complexType": { + "original": "number | string", + "resolved": "number | string | undefined", + "references": {} + }, + "mutable": false, + "attr": "max", + "reflectToAttr": false, + "docs": "A maximum value for numeric values.", + "docsTags": [], + "values": [ + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "maxLength", + "type": "number | undefined", + "complexType": { + "original": "number", + "resolved": "number | undefined", + "references": {} + }, + "mutable": false, + "attr": "max-length", + "reflectToAttr": false, + "docs": "A maximum length (number of characters) for textual values.", + "docsTags": [], + "values": [ + { + "type": "number" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "min", + "type": "number | string | undefined", + "complexType": { + "original": "number | string", + "resolved": "number | string | undefined", + "references": {} + }, + "mutable": false, + "attr": "min", + "reflectToAttr": false, + "docs": "A minimum value for numeric values.", + "docsTags": [], + "values": [ + { + "type": "number" + }, + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "minLength", + "type": "number | undefined", + "complexType": { + "original": "number", + "resolved": "number | undefined", + "references": {} + }, + "mutable": false, + "attr": "min-length", + "reflectToAttr": false, + "docs": "A minimum length (number of characters) for textual values.", + "docsTags": [], + "values": [ + { + "type": "number" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "multiple", + "type": "boolean | undefined", + "complexType": { + "original": "boolean", + "resolved": "boolean | undefined", + "references": {} + }, + "mutable": false, + "attr": "multiple", + "reflectToAttr": false, + "docs": "Whether the input should allow multiple files to be selected.", + "docsTags": [], + "values": [ + { + "type": "boolean" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "name", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "name", + "reflectToAttr": false, + "docs": "The name of the form control. Submitted with the form as part of a name/value pair.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "nativeAttributes", + "type": "undefined | { [key: string]: string; }", + "complexType": { + "original": "{ [key: string]: string }", + "resolved": "undefined | { [key: string]: string; }", + "references": {} + }, + "mutable": false, + "reflectToAttr": false, + "docs": "Attributes that will be added to the native HTML input element.", + "docsTags": [], + "values": [ + { + "type": "undefined" + }, + { + "type": "{ [key: string]: string; }" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "placeholder", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "placeholder", + "reflectToAttr": false, + "docs": "The placeholder text to display within the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "readonly", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "readonly", + "reflectToAttr": false, + "docs": "The value is not editable.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "required", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "required", + "reflectToAttr": false, + "docs": "A value is required or must be check for the form to be submittable.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "requiredMarker", + "type": "\"none!\" | \"none\" | \"optional!\" | \"optional\" | \"required!\" | \"required\" | undefined", + "complexType": { + "original": "'none' | 'required' | 'optional' | 'none!' | 'optional!' | 'required!'", + "resolved": "\"none!\" | \"none\" | \"optional!\" | \"optional\" | \"required!\" | \"required\" | undefined", + "references": {} + }, + "mutable": false, + "attr": "required-marker", + "reflectToAttr": false, + "docs": "Whether the label need a marker to shown if the input is required or optional.", + "docsTags": [ + { + "name": "default", + "text": "'optional'" + } + ], + "default": "'optional'", + "values": [ + { + "value": "none!", + "type": "string" + }, + { + "value": "none", + "type": "string" + }, + { + "value": "optional!", + "type": "string" + }, + { + "value": "optional", + "type": "string" + }, + { + "value": "required!", + "type": "string" + }, + { + "value": "required", + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "round", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "round", + "reflectToAttr": false, + "docs": "Use round input edges.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "testId", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "test-id", + "reflectToAttr": false, + "docs": "A unique identifier for the underlying native element that is used for\ntesting purposes. The attribute is added as `data-test` attribute and acts\nas a shorthand for `nativeAttributes={ 'data-test': 'test-Id' }`.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "textPrefix", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "text-prefix", + "reflectToAttr": false, + "docs": "A textual prefix to be displayed in the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "textSuffix", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": false, + "attr": "text-suffix", + "reflectToAttr": false, + "docs": "A textual suffix to be displayed in the input.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "timeMaskOptions", + "type": "FormatTimeMaskOptions | undefined", + "complexType": { + "original": "FormatTimeMaskOptions", + "resolved": "FormatTimeMaskOptions | undefined", + "references": { + "FormatTimeMaskOptions": { + "location": "local", + "path": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-input/cat-input.tsx", + "id": "src/components/cat-input/cat-input.tsx::FormatTimeMaskOptions" + } + } + }, + "mutable": false, + "reflectToAttr": false, + "docs": "Activates cleave-zen time mask on input", + "docsTags": [], + "values": [ + { + "type": "FormatTimeMaskOptions" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "togglePassword", + "type": "boolean", + "complexType": { + "original": "boolean", + "resolved": "boolean", + "references": {} + }, + "mutable": false, + "attr": "toggle-password", + "reflectToAttr": false, + "docs": "Whether the input should show a password toggle button for password inputs.", + "docsTags": [ + { + "name": "default", + "text": "false" + } + ], + "default": "false", + "values": [ + { + "type": "boolean" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "type", + "type": "\"color\" | \"email\" | \"file\" | \"number\" | \"password\" | \"range\" | \"search\" | \"tel\" | \"text\" | \"url\"", + "complexType": { + "original": "InputType", + "resolved": "\"color\" | \"email\" | \"file\" | \"number\" | \"password\" | \"range\" | \"search\" | \"tel\" | \"text\" | \"url\"", + "references": { + "InputType": { + "location": "import", + "path": "./input-type", + "id": "src/components/cat-input/input-type.ts::InputType" + } + } + }, + "mutable": false, + "attr": "type", + "reflectToAttr": false, + "docs": "Type of form control.", + "docsTags": [ + { + "name": "default", + "text": "'text'" + } + ], + "default": "'text'", + "values": [ + { + "value": "color", + "type": "string" + }, + { + "value": "email", + "type": "string" + }, + { + "value": "file", + "type": "string" + }, + { + "value": "number", + "type": "string" + }, + { + "value": "password", + "type": "string" + }, + { + "value": "range", + "type": "string" + }, + { + "value": "search", + "type": "string" + }, + { + "value": "tel", + "type": "string" + }, + { + "value": "text", + "type": "string" + }, + { + "value": "url", + "type": "string" + } + ], + "optional": false, + "required": false, + "getter": false, + "setter": false + }, + { + "name": "value", + "type": "string | undefined", + "complexType": { + "original": "string", + "resolved": "string | undefined", + "references": {} + }, + "mutable": true, + "attr": "value", + "reflectToAttr": false, + "docs": "The value of the control.", + "docsTags": [], + "values": [ + { + "type": "string" + }, + { + "type": "undefined" + } + ], + "optional": true, + "required": false, + "getter": false, + "setter": false + } + ], + "methods": [ + { + "name": "clear", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "clear() => Promise", + "parameters": [], + "docs": "Clear the input.", + "docsTags": [] + }, + { + "name": "doBlur", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "() => Promise", + "parameters": [], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + } + }, + "return": "Promise" + }, + "signature": "doBlur() => Promise", + "parameters": [], + "docs": "Programmatically remove focus from the input. Use this method instead of\n`input.blur()`.", + "docsTags": [] + }, + { + "name": "doFocus", + "returns": { + "type": "Promise", + "docs": "" + }, + "complexType": { + "signature": "(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "references": { + "Promise": { + "location": "global", + "id": "global::Promise" + }, + "FocusOptions": { + "location": "global", + "id": "global::FocusOptions" + } + }, + "return": "Promise" + }, + "signature": "doFocus(options?: FocusOptions) => Promise", + "parameters": [ + { + "name": "options", + "type": "FocusOptions | undefined", + "docs": "An optional object providing options to control aspects of\nthe focusing process." + } + ], + "docs": "Programmatically move focus to the input. Use this method instead of\n`input.focus()`.", + "docsTags": [ + { + "name": "param", + "text": "options An optional object providing options to control aspects of\nthe focusing process." + } + ] + } + ], + "events": [ + { + "event": "catBlur", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the input loses focus.", + "docsTags": [] + }, + { + "event": "catChange", + "detail": "string", + "bubbles": true, + "complexType": { + "original": "string", + "resolved": "string", + "references": {} + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the value is changed.", + "docsTags": [] + }, + { + "event": "catChangeFiles", + "detail": "FileList | null", + "bubbles": true, + "complexType": { + "original": "FileList | null", + "resolved": "FileList | null", + "references": { + "FileList": { + "location": "global", + "id": "global::FileList" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted if the input type is \"file\" and files are selected.", + "docsTags": [] + }, + { + "event": "catFocus", + "detail": "FocusEvent", + "bubbles": true, + "complexType": { + "original": "FocusEvent", + "resolved": "FocusEvent", + "references": { + "FocusEvent": { + "location": "global", + "id": "global::FocusEvent" + } + } + }, + "cancelable": true, + "composed": true, + "docs": "Emitted when the input received focus.", + "docsTags": [] + } + ], + "styles": [], + "slots": [ + { + "name": "counter", + "docs": "Custom counter element to be displayed in the top right corner of the label." + }, + { + "name": "hint", + "docs": "Optional hint element to be displayed with the input." + }, + { + "name": "label", + "docs": "The slotted label. If both the label property and the label slot are present, only the label slot will be displayed." + } + ], + "parts": [ + { + "name": "input", + "docs": "The native input element." + }, + { + "name": "label", + "docs": "The native label element." + }, + { + "name": "prefix", + "docs": "The text prefix." + }, + { + "name": "suffix", + "docs": "The text suffix." + } + ], + "listeners": [] +} \ No newline at end of file diff --git a/core/src/components/cat-pagination/docs.json b/core/src/components/cat-pagination/docs.json new file mode 100644 index 000000000..6f68764e6 --- /dev/null +++ b/core/src/components/cat-pagination/docs.json @@ -0,0 +1,366 @@ +{ + "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-pagination", + "filePath": "src/components/cat-pagination/cat-pagination.tsx", + "fileName": "cat-pagination.tsx", + "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-pagination/readme.md", + "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-pagination/usage", + "tag": "cat-pagination", + "readme": "# cat-pagination\n\n\n", + "overview": "A navigation component to switch between different pages of paged chunks of\ndata such as a table. Pagination is built with list HTML elements and a\nwrapping `