{ "timestamp": "2024-08-02T15:58:10", "compiler": { "name": "@stencil/core", "version": "4.18.0", "typescriptVersion": "5.4.5" }, "components": [ { "filePath": "src/components/pds-avatar/pds-avatar.tsx", "encapsulation": "shadow", "tag": "pds-avatar", "readme": "# pds-avatar\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "alt", "type": "string", "complexType": { "original": "string | null", "resolved": "string", "references": {} }, "mutable": false, "attr": "alt", "reflectToAttr": false, "docs": "The alt for a custom user image. s", "docsTags": [ { "name": "defaultValue", "text": "null" } ], "default": "null", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "badge", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "badge", "reflectToAttr": false, "docs": "Determines whether the badge is visible or not.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "dropdown", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "dropdown", "reflectToAttr": false, "docs": "Determines whether the avatar functions as a dropdown trigger.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "image", "type": "string", "complexType": { "original": "string | null", "resolved": "string", "references": {} }, "mutable": false, "attr": "image", "reflectToAttr": false, "docs": "The src for a custom user image.", "docsTags": [ { "name": "defaultValue", "text": "null" } ], "default": "null", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "size", "type": "string", "complexType": { "original": "| 'xxl' // 72px\n | 'xl' // 64px\n | 'lg' // 56px\n | 'md' // 40px\n | 'sm' // 32px\n | 'xs' // 24px\n | string", "resolved": "string", "references": {} }, "mutable": false, "attr": "size", "reflectToAttr": true, "docs": "Size of the avatar. Value can be preset or custom.", "docsTags": [ { "name": "defaultValue", "text": "lg" } ], "default": "'lg'", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "variant", "type": "\"admin\" | \"customer\"", "complexType": { "original": "'customer' | 'admin'", "resolved": "\"admin\" | \"customer\"", "references": {} }, "mutable": false, "attr": "variant", "reflectToAttr": true, "docs": "Determines the variant of avatar. Changes appearance accordingly.", "docsTags": [ { "name": "defaultValue", "text": "customer" } ], "default": "'customer'", "values": [ { "value": "admin", "type": "string" }, { "value": "customer", "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "pds-icon" ], "dependencyGraph": { "pds-avatar": [ "pds-icon" ] } }, { "filePath": "src/components/pds-button/pds-button.tsx", "encapsulation": "shadow", "tag": "pds-button", "readme": "# pds-button\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Toggles disabled state of button", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "icon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "icon", "reflectToAttr": false, "docs": "Displays icon before text when icon string matches an icon name", "docsTags": [], "default": "null", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "Provides button with a submittable name", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "type", "type": "\"button\" | \"reset\" | \"submit\"", "complexType": { "original": "'button' | 'reset' | 'submit'", "resolved": "\"button\" | \"reset\" | \"submit\"", "references": {} }, "mutable": false, "attr": "type", "reflectToAttr": false, "docs": "Provides button with a type", "docsTags": [ { "name": "defaultValue", "text": "button" } ], "default": "'button'", "values": [ { "value": "button", "type": "string" }, { "value": "reset", "type": "string" }, { "value": "submit", "type": "string" } ], "optional": true, "required": false }, { "name": "value", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "Provides button with a submittable value", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "variant", "type": "\"accent\" | \"destructive\" | \"disclosure\" | \"primary\" | \"secondary\" | \"unstyled\"", "complexType": { "original": "'primary' | 'secondary' | 'accent' | 'disclosure' | 'destructive' | 'unstyled'", "resolved": "\"accent\" | \"destructive\" | \"disclosure\" | \"primary\" | \"secondary\" | \"unstyled\"", "references": {} }, "mutable": false, "attr": "variant", "reflectToAttr": false, "docs": "Sets button variant styles as outlined in Figma documentation", "docsTags": [], "default": "'primary'", "values": [ { "value": "accent", "type": "string" }, { "value": "destructive", "type": "string" }, { "value": "disclosure", "type": "string" }, { "value": "primary", "type": "string" }, { "value": "secondary", "type": "string" }, { "value": "unstyled", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "pds-copytext" ], "dependencies": [ "pds-icon" ], "dependencyGraph": { "pds-button": [ "pds-icon" ], "pds-copytext": [ "pds-button" ] } }, { "filePath": "src/components/pds-checkbox/pds-checkbox.tsx", "encapsulation": "shadow", "tag": "pds-checkbox", "readme": "# pds-checkbox\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "checked", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "checked", "reflectToAttr": false, "docs": "It determines whether or not the checkbox is checked.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute and the label `for` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "It determines whether or not the checkbox is disabled.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "errorMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "error-message", "reflectToAttr": false, "docs": "Displays message text describing an invalid state.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "helperMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "helper-message", "reflectToAttr": false, "docs": "String used for helper message below checkbox.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "indeterminate", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "indeterminate", "reflectToAttr": false, "docs": "If `true`, the checkbox will visually appear as indeterminate.\nOnly JavaScript can set the objects `indeterminate` property. See [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes).", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "invalid", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "invalid", "reflectToAttr": false, "docs": "It determines whether or not the checkbox is invalid.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "String used for label text next to checkbox.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "labelHidden", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "label-hidden", "reflectToAttr": false, "docs": "Visually hides the label text for instances where only the checkbox should be displayed. Label remains accessible to assistive technology such as screen readers.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "name", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "String used for checkbox `name` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "It determines whether or not the checkbox is required.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The value of the checkbox that is submitted with a form.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "pdsCheckboxChange", "detail": "CheckboxChangeEventDetail", "bubbles": true, "complexType": { "original": "CheckboxChangeEventDetail", "resolved": "CheckboxChangeEventDetail", "references": { "CheckboxChangeEventDetail": { "location": "import", "path": "./checkbox-interface", "id": "src/components/pds-checkbox/checkbox-interface.ts::CheckboxChangeEventDetail" } } }, "cancelable": true, "composed": true, "docs": "Event emitted that contains the `value` and `checked`.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "pds-table-row" ], "dependencies": [], "dependencyGraph": { "pds-table-row": [ "pds-checkbox" ] } }, { "filePath": "src/components/pds-chip/pds-chip.tsx", "encapsulation": "shadow", "tag": "pds-chip", "readme": "# pds-chip\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "dot", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "dot", "reflectToAttr": false, "docs": "Determines whether a dot should be displayed on the chip.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Sets the text label content of the chip.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "large", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "large", "reflectToAttr": false, "docs": "Determines whether the chip should be rendered in a larger size.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "sentiment", "type": "\"accent\" | \"danger\" | \"info\" | \"neutral\" | \"success\" | \"warning\"", "complexType": { "original": "'accent' | 'danger' | 'info' | 'neutral' | 'success' | 'warning'", "resolved": "\"accent\" | \"danger\" | \"info\" | \"neutral\" | \"success\" | \"warning\"", "references": {} }, "mutable": false, "attr": "sentiment", "reflectToAttr": false, "docs": "Sets the color scheme of the chip.", "docsTags": [ { "name": "defaultValue", "text": "'neutral'" } ], "default": "'neutral'", "values": [ { "value": "accent", "type": "string" }, { "value": "danger", "type": "string" }, { "value": "info", "type": "string" }, { "value": "neutral", "type": "string" }, { "value": "success", "type": "string" }, { "value": "warning", "type": "string" } ], "optional": false, "required": false }, { "name": "variant", "type": "\"dropdown\" | \"tag\" | \"text\"", "complexType": { "original": "'text' | 'tag' | 'dropdown'", "resolved": "\"dropdown\" | \"tag\" | \"text\"", "references": {} }, "mutable": false, "attr": "variant", "reflectToAttr": false, "docs": "Sets the style variant of the chip.", "docsTags": [ { "name": "defaultValue", "text": "'text'" } ], "default": "'text'", "values": [ { "value": "dropdown", "type": "string" }, { "value": "tag", "type": "string" }, { "value": "text", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "pdsTagCloseClick", "detail": "any", "bubbles": true, "complexType": { "original": "any", "resolved": "any", "references": {} }, "cancelable": true, "composed": true, "docs": "Event when close button is clicked on tag variant.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "pds-icon" ], "dependencyGraph": { "pds-chip": [ "pds-icon" ] } }, { "filePath": "src/components/pds-copytext/pds-copytext.tsx", "encapsulation": "shadow", "tag": "pds-copytext", "readme": "# pds-copytext\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "border", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "border", "reflectToAttr": true, "docs": "Determines whether `copytext` should have a border.", "docsTags": [ { "name": "defaultValue", "text": "true" } ], "default": "true", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "fullWidth", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "full-width", "reflectToAttr": false, "docs": "Determines whether `copytext` should expand to the full width of its container.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "truncate", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "truncate", "reflectToAttr": false, "docs": "Determines whether the `value` should truncate and display with an ellipsis.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "String that is displayed and that is also copied to the clipboard upon interaction.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true } ], "methods": [], "events": [ { "event": "pdsCopyTextClick", "detail": "any", "bubbles": true, "complexType": { "original": "any", "resolved": "any", "references": {} }, "cancelable": true, "composed": true, "docs": "Event when copyText button is clicked.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "pds-button", "pds-icon" ], "dependencyGraph": { "pds-copytext": [ "pds-button", "pds-icon" ], "pds-button": [ "pds-icon" ] } }, { "filePath": "src/components/pds-divider/pds-divider.tsx", "encapsulation": "shadow", "tag": "pds-divider", "readme": "# pds-divider\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "offset", "type": "\"lg\" | \"md\" | \"sm\" | \"xl\" | \"xs\" | \"xxl\" | \"xxs\"", "complexType": { "original": "'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'", "resolved": "\"lg\" | \"md\" | \"sm\" | \"xl\" | \"xs\" | \"xxl\" | \"xxs\"", "references": {} }, "mutable": false, "attr": "offset", "reflectToAttr": false, "docs": "Adds offset margin/padding to expand the width (horizontal) or the height (vertical) of divider.", "docsTags": [], "values": [ { "value": "lg", "type": "string" }, { "value": "md", "type": "string" }, { "value": "sm", "type": "string" }, { "value": "xl", "type": "string" }, { "value": "xs", "type": "string" }, { "value": "xxl", "type": "string" }, { "value": "xxs", "type": "string" } ], "optional": false, "required": false }, { "name": "vertical", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "vertical", "reflectToAttr": false, "docs": "Sets divider to display vertically", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-image/pds-image.tsx", "encapsulation": "shadow", "tag": "pds-image", "readme": "# pds-image\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "alt", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "alt", "reflectToAttr": false, "docs": "The image's alt tag. If none is provided,\nit will default to an empty string.", "docsTags": [], "default": "''", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "height", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": false, "attr": "height", "reflectToAttr": false, "docs": "The height of the image in pixels. Setting this will\ndevote space in the layout to prevent layout\nshifts when the image is loaded.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "loading", "type": "\"eager\" | \"lazy\"", "complexType": { "original": "'eager' | 'lazy'", "resolved": "\"eager\" | \"lazy\"", "references": {} }, "mutable": false, "attr": "loading", "reflectToAttr": false, "docs": "Indicates how the browser should load the image.", "docsTags": [], "default": "'eager'", "values": [ { "value": "eager", "type": "string" }, { "value": "lazy", "type": "string" } ], "optional": true, "required": false }, { "name": "sizes", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "sizes", "reflectToAttr": false, "docs": "Determines the intended display size of an image\nwithin certian breakpoints. Has no effect if `srcset`\nis not set or value has no width descriptor.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "src", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "src", "reflectToAttr": false, "docs": "The image's source.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "srcset", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "srcset", "reflectToAttr": false, "docs": "A set of image sources for the browser to use.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "width", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": false, "attr": "width", "reflectToAttr": false, "docs": "The width of the image in pixels. Setting this will\ndevote space in the layout to prevent layout\nshifts when the image is loaded.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--image-aspect-ratio", "annotation": "prop", "docs": "The image's aspect ratio." } ], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-input/pds-input.tsx", "encapsulation": "shadow", "tag": "pds-input", "readme": "# pds-input\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Indicates whether or not the input field is disabled.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "errorMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "error-message", "reflectToAttr": false, "docs": "Specifies the error message and provides an error-themed treatment to the field.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "helperMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "helper-message", "reflectToAttr": false, "docs": "Displays a message or hint below the input field.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "invalid", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "invalid", "reflectToAttr": false, "docs": "Indicates whether or not the input field is invalid or throws an error.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Text to be displayed as the input label.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "Specifies the name. Submitted with the form name/value pair.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "placeholder", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "Specifies a short hint that describes the expected value of the input field.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "readonly", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "readonly", "reflectToAttr": false, "docs": "Indicates whether or not the input field is readonly.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "required", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "Indicates whether or not the input field is required.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "type", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "type", "reflectToAttr": false, "docs": "Determines the type of control that will be displayed\n`'email'`, `'number'`, `'password'`, `'tel'`, `'text'`", "docsTags": [ { "name": "defaultValue", "text": "\"text\"" } ], "default": "'text'", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The value of the input.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [ { "event": "pdsInput", "detail": "InputEvent", "bubbles": true, "complexType": { "original": "InputEvent", "resolved": "InputEvent", "references": { "InputEvent": { "location": "global", "id": "global::InputEvent" } } }, "cancelable": true, "composed": true, "docs": "Emitted when a keyboard input occurred.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-link/pds-link.tsx", "encapsulation": "shadow", "tag": "pds-link", "readme": "# pds-link\n\nLink is mainly used as navigational element and usually appear within or directly following a paragraph or sentence. The \"plain link\" is used for interactive user generated text like product, post, and offer titles.\n", "docs": "Link is mainly used as navigational element and usually appear within or directly following a paragraph or sentence. The \"plain link\" is used for interactive user generated text like product, post, and offer titles.", "docsTags": [ { "name": "slot", "text": "- Content is placed between the opening closing tags" } ], "usage": {}, "props": [ { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "external", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "external", "reflectToAttr": false, "docs": "When enabled, opens link in a new tab.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "fontSize", "type": "\"lg\" | \"md\" | \"sm\"", "complexType": { "original": "'sm' | 'md' | 'lg'", "resolved": "\"lg\" | \"md\" | \"sm\"", "references": {} }, "mutable": false, "attr": "font-size", "reflectToAttr": false, "docs": "\nThe Font size follows t-shirt model\nsm: 12px\nmd: 14px\nlg: 16px", "docsTags": [ { "name": "defaultValue", "text": "lg" } ], "default": "'lg'", "values": [ { "value": "lg", "type": "string" }, { "value": "md", "type": "string" }, { "value": "sm", "type": "string" } ], "optional": false, "required": false }, { "name": "href", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "href", "reflectToAttr": false, "docs": "The URL that the hyperlink points to.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "variant", "type": "\"inline\" | \"plain\"", "complexType": { "original": "'inline' | 'plain'", "resolved": "\"inline\" | \"plain\"", "references": {} }, "mutable": false, "attr": "variant", "reflectToAttr": false, "docs": "\nModifies the look of the link", "docsTags": [], "default": "'inline'", "values": [ { "value": "inline", "type": "string" }, { "value": "plain", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "Content is placed between the opening closing tags" } ], "parts": [], "dependents": [], "dependencies": [ "pds-icon" ], "dependencyGraph": { "pds-link": [ "pds-icon" ] } }, { "filePath": "src/components/pds-progress/pds-progress.tsx", "encapsulation": "shadow", "tag": "pds-progress", "readme": "# pds-progress\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "animated", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "animated", "reflectToAttr": false, "docs": "Determines whether or not progress is animated.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute and the label `for` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "fillColor", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "fill-color", "reflectToAttr": false, "docs": "Sets the progress fill color. Accepts a color token or a [valid color value](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value).", "docsTags": [ { "name": "defaultValue", "text": "'var(--pds-color-primary)'" } ], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "String used for label text. Label is visually hidden but required for better accessibility.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "percent", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": false, "attr": "percent", "reflectToAttr": false, "docs": "Sets the progress fill pecentage and visually displayed when `show-percentage=true`.", "docsTags": [ { "name": "defaultValue", "text": "0" } ], "default": "0", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "showPercent", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "show-percent", "reflectToAttr": false, "docs": "Determines whether or not the percent value should be displayed as text.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-radio/pds-radio.tsx", "encapsulation": "scoped", "tag": "pds-radio", "readme": "# pds-radio\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "checked", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "checked", "reflectToAttr": false, "docs": "Determines whether or not the radio is checked.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute and the label `for` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Determines whether or not the radio is disabled.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "errorMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "error-message", "reflectToAttr": false, "docs": "Displays message text describing an invalid state.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "helperMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "helper-message", "reflectToAttr": false, "docs": "String used for helper message below radio.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "invalid", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "invalid", "reflectToAttr": false, "docs": "Determines whether or not the radio is invalid.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "String used for label text next to radio.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "name", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "String used for radio `name` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "Determines whether or not the radio is required.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The value of the radio that is submitted with a form.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "pdsRadioChange", "detail": "boolean", "bubbles": true, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "cancelable": true, "composed": true, "docs": "Emits a boolean indicating whether the checkbox is currently checked or unchecked.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-sortable/pds-sortable.tsx", "encapsulation": "scoped", "tag": "pds-sortable", "readme": "# pds-sortable\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "border", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "border", "reflectToAttr": true, "docs": "Determines whether `sortable` should have a border.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the sortable container `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "dividers", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "dividers", "reflectToAttr": true, "docs": "Deternines whether `sortable` items should be divided with border.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "handleType", "type": "\"handle\" | \"row\"", "complexType": { "original": "'handle' | 'row'", "resolved": "\"handle\" | \"row\"", "references": {} }, "mutable": false, "attr": "handle-type", "reflectToAttr": false, "docs": "Determines the grabbable area for the `pds-sortable-item`.", "docsTags": [], "default": "'row'", "values": [ { "value": "handle", "type": "string" }, { "value": "row", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "pdsSortableItemMoved", "detail": "any", "bubbles": true, "complexType": { "original": "any", "resolved": "any", "references": {} }, "cancelable": true, "composed": true, "docs": "Event emitted when a sortable item is moved.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-sortable/pds-sortable-item/pds-sortable-item.tsx", "encapsulation": "scoped", "tag": "pds-sortable-item", "readme": "# pds-sortable-item\n\n\n", "docs": "", "docsTags": [ { "name": "slot", "text": "sortable-item-actions - Content is placed within the `pds-sortable-item__actions` element as children. This slot is only rendered if `actions` is set to `true`." } ], "usage": {}, "props": [ { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the sortable item `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "enableActions", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "enable-actions", "reflectToAttr": false, "docs": "Determines whether `sortable-item-actions` slot should be enabled.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "handle", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "handle", "reflectToAttr": false, "docs": "Determines whether `sortable-item` should have a handle.", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "sortable-item-actions", "docs": "Content is placed within the `pds-sortable-item__actions` element as children. This slot is only rendered if `actions` is set to `true`." } ], "parts": [], "dependents": [], "dependencies": [ "pds-icon" ], "dependencyGraph": { "pds-sortable-item": [ "pds-icon" ] } }, { "filePath": "src/components/pds-switch/pds-switch.tsx", "encapsulation": "shadow", "tag": "pds-switch", "readme": "# pds-switch\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "checked", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "checked", "reflectToAttr": false, "docs": "Determines the input 'checked' state", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute and the label `for` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Determines the input 'disabled' state, preventing user interaction", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "errorMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "error-message", "reflectToAttr": false, "docs": "Displays message text describing an invalid state", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "helperMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "helper-message", "reflectToAttr": false, "docs": "Displays help text for additional description of an input", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "invalid", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "invalid", "reflectToAttr": false, "docs": "Determines the input 'invalid' state, signifying an error is present", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Displays text to describe the input", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "name", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "Identifies form data and unifies a group of radio inputs for toggling a single property/value", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "Determines the 'required' state of the input", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "type", "type": "\"checkbox\" | \"radio\"", "complexType": { "original": "'checkbox' | 'radio'", "resolved": "\"checkbox\" | \"radio\"", "references": {} }, "mutable": false, "attr": "type", "reflectToAttr": false, "docs": "Specifies the underlying input element type", "docsTags": [ { "name": "defaultValue", "text": "'checkbox'" } ], "default": "'checkbox'", "values": [ { "value": "checkbox", "type": "string" }, { "value": "radio", "type": "string" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "Provides input with a string submitted in form data, and can be used to distinguish radio inputs", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "pdsSwitchChange", "detail": "InputEvent", "bubbles": true, "complexType": { "original": "InputEvent", "resolved": "InputEvent", "references": { "InputEvent": { "location": "global", "id": "global::InputEvent" } } }, "cancelable": true, "composed": true, "docs": "Emits an event on input change", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-tabs/pds-tab/pds-tab.tsx", "encapsulation": "none", "tag": "pds-tab", "readme": "# pds-tabs\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "name", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "Sets the related tab name, this name must match a `pds-tabpanel`'s tab name property", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-table/pds-table.tsx", "encapsulation": "shadow", "tag": "pds-table", "readme": "# pds-table\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "compact", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "compact", "reflectToAttr": false, "docs": "Determines if table displays compact which reduces the spacing of table cells.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the table `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "fixedColumn", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "fixed-column", "reflectToAttr": false, "docs": "Determines if table displays fixed column which fixes the first column of the table.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "responsive", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "responsive", "reflectToAttr": false, "docs": "Enables the table to be responsive by horizontally scrolling on smaller screens.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "selectable", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "selectable", "reflectToAttr": false, "docs": "Determines if table displays checkboxes for selectable rows.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [ { "event": "pdsTableSort", "capture": false, "passive": false } ], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-table/pds-table-body/pds-table-body.tsx", "encapsulation": "shadow", "tag": "pds-table-body", "readme": "# pds-table-body\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-table/pds-table-cell/pds-table-cell.tsx", "encapsulation": "shadow", "tag": "pds-table-cell", "readme": "# pds-table-cell\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "truncate", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "truncate", "reflectToAttr": false, "docs": "Truncates content to a max width of 100px and adds an ellipsis.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "pds-table-row" ], "dependencies": [], "dependencyGraph": { "pds-table-row": [ "pds-table-cell" ] } }, { "filePath": "src/components/pds-table/pds-table-head/pds-table-head.tsx", "encapsulation": "shadow", "tag": "pds-table-head", "readme": "# pds-table-head\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "pds-table-head-cell" ], "dependencyGraph": { "pds-table-head": [ "pds-table-head-cell" ], "pds-table-head-cell": [ "pds-icon" ] } }, { "filePath": "src/components/pds-table/pds-table-head-cell/pds-table-head-cell.tsx", "encapsulation": "shadow", "tag": "pds-table-head-cell", "readme": "# pds-table-head-cell\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "sortable", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "sortable", "reflectToAttr": false, "docs": "Determines whether the table column is sortable when set to `true`.", "docsTags": [], "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "pdsTableSort", "detail": "{ column: string; direction: string; }", "bubbles": true, "complexType": { "original": "{ column: string; direction: string }", "resolved": "{ column: string; direction: string; }", "references": {} }, "cancelable": true, "composed": true, "docs": "Event emitted to signal that a table column header has been sorted, providing information about the sorted column's name and sorting direction.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "pds-table-head" ], "dependencies": [ "pds-icon" ], "dependencyGraph": { "pds-table-head-cell": [ "pds-icon" ], "pds-table-head": [ "pds-table-head-cell" ] } }, { "filePath": "src/components/pds-table/pds-table-row/pds-table-row.tsx", "encapsulation": "shadow", "tag": "pds-table-row", "readme": "# pds-table-row\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [], "methods": [], "events": [ { "event": "pdsTableRowSelected", "detail": "{ rowIndex: number; isSelected: boolean; }", "bubbles": true, "complexType": { "original": "{ rowIndex: number; isSelected: boolean; }", "resolved": "{ rowIndex: number; isSelected: boolean; }", "references": {} }, "cancelable": true, "composed": true, "docs": "Event that is emitted when the checkbox is clicked, carrying the selected value.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "pds-table-cell", "pds-checkbox" ], "dependencyGraph": { "pds-table-row": [ "pds-table-cell", "pds-checkbox" ] } }, { "filePath": "src/components/pds-tabs/pds-tabpanel/pds-tabpanel.tsx", "encapsulation": "none", "tag": "pds-tabpanel", "readme": "# pds-tabs\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "name", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "Sets the related tab name, this name must match a `pds-tab`'s tab name property", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-tabs/pds-tabs.tsx", "encapsulation": "shadow", "tag": "pds-tabs", "readme": "# pds-tabs\n\n\n", "docs": "", "docsTags": [ { "name": "slot", "text": "tabs - Content is placed within the `div[role=\"tablist\"]` element as children" }, { "name": "slot", "text": "tabpanels - Content is placed directly after the `div[role=\"tablist\"]` element as siblings" } ], "usage": {}, "props": [ { "name": "activeTabName", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "active-tab-name", "reflectToAttr": false, "docs": "Sets the starting active tab name and maintains the name as the component re-renders", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "tablistLabel", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "tablist-label", "reflectToAttr": false, "docs": "Sets the aria-label attached to the tablist element", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "variant", "type": "\"availability\" | \"filter\" | \"primary\"", "complexType": { "original": "'primary' | 'availability' | 'filter'", "resolved": "\"availability\" | \"filter\" | \"primary\"", "references": {} }, "mutable": false, "attr": "variant", "reflectToAttr": false, "docs": "Sets tabs variant styles as outlined in Figma documentation", "docsTags": [], "values": [ { "value": "availability", "type": "string" }, { "value": "filter", "type": "string" }, { "value": "primary", "type": "string" } ], "optional": false, "required": true } ], "methods": [], "events": [], "listeners": [ { "event": "pdsTabClick", "target": "body", "capture": false, "passive": false }, { "event": "keydown", "capture": false, "passive": false } ], "styles": [ { "name": "--panel-margin-top", "annotation": "prop", "docs": "Optional margin-top for panels" }, { "name": "--panel-padding", "annotation": "prop", "docs": "Optional padding for panels" } ], "slots": [ { "name": "tabpanels", "docs": "Content is placed directly after the `div[role=\"tablist\"]` element as siblings" }, { "name": "tabs", "docs": "Content is placed within the `div[role=\"tablist\"]` element as children" } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-textarea/pds-textarea.tsx", "encapsulation": "shadow", "tag": "pds-textarea", "readme": "# pds-textarea\n\n\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "Indicates whether or not the textarea is disabled", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "errorMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "error-message", "reflectToAttr": false, "docs": "Specifies the error text and provides an error-themed treatment to the field", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "helperMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "helper-message", "reflectToAttr": false, "docs": "Displays a hint or description of the textarea", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "invalid", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "invalid", "reflectToAttr": false, "docs": "Indicates whether or not the textarea is invalid or throws an error", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Text to be displayed as the textarea label", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "Specifies the name, submitted with the form name/value pair. This value will mirror the componentId", "docsTags": [], "default": "this.componentId", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "placeholder", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "Specifies a short hint that describes the expected value of the textarea", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "readonly", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "readonly", "reflectToAttr": false, "docs": "Indicates whether or not the textarea is readonly", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "required", "reflectToAttr": false, "docs": "Indicates whether or not the textarea is required", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "rows", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": false, "attr": "rows", "reflectToAttr": false, "docs": "Sets number of rows of text visible without needing to scroll in the textarea", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "value", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The value of the textarea", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [ { "event": "pdsTextareaChange", "detail": "TextareaChangeEventDetail", "bubbles": true, "complexType": { "original": "TextareaChangeEventDetail", "resolved": "TextareaChangeEventDetail", "references": { "TextareaChangeEventDetail": { "location": "import", "path": "./textarea-interface", "id": "src/components/pds-textarea/textarea-interface.ts::TextareaChangeEventDetail" } } }, "cancelable": true, "composed": true, "docs": "Event emitted whenever the value of the textarea changes", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/pds-tooltip/pds-tooltip.tsx", "encapsulation": "shadow", "tag": "pds-tooltip", "readme": "# pds-tooltip\n\n\n", "docs": "", "docsTags": [ { "name": "slot", "text": "(default) - The tooltip's target element" }, { "name": "slot", "text": "content - HTML content for the tooltip" } ], "usage": {}, "props": [ { "name": "componentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "component-id", "reflectToAttr": false, "docs": "A unique identifier used for the underlying component `id` attribute.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "content", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "content", "reflectToAttr": false, "docs": "Content for the tooltip. If HTML is required, use the content slot", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "hasArrow", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "has-arrow", "reflectToAttr": false, "docs": "Determines whether or not the tooltip has an arrow", "docsTags": [ { "name": "defaultValue", "text": "true" } ], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "htmlContent", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "html-content", "reflectToAttr": false, "docs": "Enable this option when using the content slot", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "opened", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "opened", "reflectToAttr": true, "docs": "Determines whether or not the tooltip is visible", "docsTags": [ { "name": "defaultValue", "text": "false" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": 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": "'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'", "resolved": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\"", "references": {} }, "mutable": false, "attr": "placement", "reflectToAttr": true, "docs": "Determines the preferred position of the tooltip", "docsTags": [ { "name": "defaultValue", "text": "\"right\"" } ], "default": "'right'", "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 } ], "methods": [ { "name": "hideTooltip", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "() => Promise", "parameters": [], "references": { "Promise": { "location": "global", "id": "global::Promise" } }, "return": "Promise" }, "signature": "hideTooltip() => Promise", "parameters": [], "docs": "Hides the tooltip by disabling the opened property", "docsTags": [] }, { "name": "showTooltip", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "() => Promise", "parameters": [], "references": { "Promise": { "location": "global", "id": "global::Promise" } }, "return": "Promise" }, "signature": "showTooltip() => Promise", "parameters": [], "docs": "Shows the tooltip by enabling the opened property", "docsTags": [] } ], "events": [ { "event": "pdsTooltipHide", "detail": "any", "bubbles": true, "complexType": { "original": "any", "resolved": "any", "references": {} }, "cancelable": true, "composed": true, "docs": "Emitted after a tooltip is closed", "docsTags": [] }, { "event": "pdsTooltipShow", "detail": "any", "bubbles": true, "complexType": { "original": "any", "resolved": "any", "references": {} }, "cancelable": true, "composed": true, "docs": "Emitted after a tooltip is shown", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "(default)", "docs": "The tooltip's target element" }, { "name": "content", "docs": "HTML content for the tooltip" } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} } ], "typeLibrary": { "src/components/pds-checkbox/checkbox-interface.ts::CheckboxChangeEventDetail": { "declaration": "export interface CheckboxChangeEventDetail {\n checked: boolean;\n value: T;\n}", "docstring": "", "path": "src/components/pds-checkbox/checkbox-interface.ts" }, "src/components/pds-textarea/textarea-interface.ts::TextareaChangeEventDetail": { "declaration": "export interface TextareaChangeEventDetail {\n event?: Event;\n value: string | null;\n}", "docstring": "", "path": "src/components/pds-textarea/textarea-interface.ts" } } }