{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/base/sgds-element.ts", "declarations": [ { "kind": "class", "description": "", "name": "SgdsElement", "members": [ { "kind": "method", "name": "emit", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "CustomEventInit" } } ], "description": "Emits a custom event with more convenient defaults.", "type": {} }, { "kind": "method", "name": "define", "static": true, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "elementConstructor", "default": "this" }, { "name": "options", "default": "{}", "type": { "text": "ElementDefinitionOptions" } } ], "type": {} } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "sgds-element", "customElement": true, "modulePath": "src/base/sgds-element.ts" }, { "kind": "class", "description": "", "name": "anonymous_1", "superclass": { "name": "elementConstructor", "module": "src/base/sgds-element.ts" }, "tagName": "name", "customElement": true, "modulePath": "src/base/sgds-element.ts", "definitionPath": "src/base/sgds-element.ts" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } }, { "kind": "custom-element-definition", "name": "name", "declaration": { "name": "elementConstructor", "module": "src/base/sgds-element.ts" } }, { "kind": "custom-element-definition", "name": "name", "declaration": { "name": "anonymous_1", "module": "src/base/sgds-element.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/Accordion/sgds-accordion-item.ts", "declarations": [ { "kind": "class", "description": "", "name": "SgdsAccordionItem", "slots": [ { "description": "An icon placed before the header text, typically used to provide visual context for the accordion item.", "name": "icon" }, { "description": "The accordion-item button header slot.", "name": "header" }, { "description": "A badge placed after the header text, aligned to the right via auto left margin.", "name": "badge" }, { "description": "The accordion-item content slot.", "name": "content" }, { "description": "The caret icon of accordion-item. Defaults to a chevron-down icon.", "name": "caret" } ], "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether accordion-item is open or close", "attribute": "open", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the accordion item", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "density", "type": { "text": "AccordionDensity" }, "default": "\"default\"", "description": "Controls the density of the individual accordion item. This value is controlled by sgds-accordion", "attribute": "density", "reflects": true }, { "kind": "field", "name": "ariaLabel", "type": { "text": "string" }, "default": "\"\"", "description": "The aria-label attribute forwarded to the accordion item button.", "attribute": "ariaLabel" }, { "kind": "method", "name": "handleSummaryClick", "privacy": "private", "type": {} }, { "kind": "method", "name": "handleSummaryKeyDown", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ], "type": {} }, { "kind": "method", "name": "handleOpenChange", "type": {} }, { "kind": "method", "name": "show", "privacy": "public", "description": "Shows the accordion.", "type": {} }, { "kind": "method", "name": "hide", "privacy": "public", "description": "Hide the accordion", "type": {} }, { "kind": "method", "name": "emit", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "CustomEventInit" } } ], "description": "Emits a custom event with more convenient defaults.", "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } }, { "kind": "method", "name": "define", "static": true, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "elementConstructor", "default": "this" }, { "name": "options", "default": "{}", "type": { "text": "ElementDefinitionOptions" } } ], "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } } ], "events": [ { "description": "Emitted on show.", "name": "sgds-show", "reactName": "onSgdsShow" }, { "description": "Emitted on show after animation has completed.", "name": "sgds-after-show", "reactName": "onSgdsAfterShow" }, { "description": "Emitted on hide.", "name": "sgds-hide", "reactName": "onSgdsHide" }, { "description": "Emitted on hide after animation has completed.", "name": "sgds-after-hide", "reactName": "onSgdsAfterHide" } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether accordion-item is open or close", "fieldName": "open" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the accordion item", "fieldName": "disabled" }, { "name": "density", "type": { "text": "AccordionDensity" }, "default": "\"default\"", "description": "Controls the density of the individual accordion item. This value is controlled by sgds-accordion", "fieldName": "density" }, { "name": "ariaLabel", "type": { "text": "string" }, "default": "\"\"", "description": "The aria-label attribute forwarded to the accordion item button.", "fieldName": "ariaLabel" } ], "superclass": { "name": "SgdsElement", "module": "/src/base/sgds-element" }, "tagName": "sgds-accordion-item", "customElement": true, "modulePath": "src/components/Accordion/sgds-accordion-item.ts", "cssProperties": [], "cssParts": [], "cssStates": [] } ], "exports": [ { "kind": "js", "name": "SgdsAccordionItem", "declaration": { "name": "SgdsAccordionItem", "module": "src/components/Accordion/sgds-accordion-item.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "SgdsAccordionItem", "module": "src/components/Accordion/sgds-accordion-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/Accordion/sgds-accordion.ts", "declarations": [ { "kind": "class", "description": "", "name": "SgdsAccordion", "slots": [ { "description": "slot for accordion-item", "name": "default" } ], "members": [ { "kind": "field", "name": "allowMultiple", "type": { "text": "boolean" }, "default": "false", "description": "Allows multiple accordion items to be opened at the same time", "attribute": "allowMultiple", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "\"default\" | \"border\"" }, "default": "\"default\"", "description": "The variant of accordion", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "density", "type": { "text": "\"default\" | \"compact\" | \"spacious\"" }, "default": "\"default\"", "description": "The density of accordion", "attribute": "density", "reflects": true }, { "kind": "method", "name": "_handleSlotChange", "privacy": "private", "type": {} }, { "kind": "method", "name": "_onToggle", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "type": {} }, { "kind": "method", "name": "_onKeyboardToggle", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ], "type": {} }, { "kind": "method", "name": "emit", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "CustomEventInit" } } ], "description": "Emits a custom event with more convenient defaults.", "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } }, { "kind": "method", "name": "define", "static": true, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "elementConstructor", "default": "this" }, { "name": "options", "default": "{}", "type": { "text": "ElementDefinitionOptions" } } ], "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } } ], "attributes": [ { "name": "allowMultiple", "type": { "text": "boolean" }, "default": "false", "description": "Allows multiple accordion items to be opened at the same time", "fieldName": "allowMultiple" }, { "name": "variant", "type": { "text": "AccordionVariant" }, "default": "\"default\"", "description": "The variant of accordion", "fieldName": "variant" }, { "name": "density", "type": { "text": "AccordionDensity" }, "default": "\"default\"", "description": "The density of accordion", "fieldName": "density" } ], "superclass": { "name": "SgdsElement", "module": "/src/base/sgds-element" }, "summary": "A dropdown mechanism that allow users to either show or hide related content. `SgdsAccordion` is a wrapper to manage the behaviour for multiple `SgdsAccordionItems`", "tagName": "sgds-accordion", "customElement": true, "modulePath": "src/components/Accordion/sgds-accordion.ts", "cssProperties": [], "cssParts": [], "cssStates": [], "events": [] } ], "exports": [ { "kind": "js", "name": "SgdsAccordion", "declaration": { "name": "SgdsAccordion", "module": "src/components/Accordion/sgds-accordion.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "SgdsAccordion", "module": "src/components/Accordion/sgds-accordion.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/Alert/sgds-alert-link.ts", "declarations": [ { "kind": "class", "description": "", "name": "SgdsAlertLink", "slots": [ { "description": "The text content of the anchor element", "name": "default" } ], "members": [ { "kind": "field", "name": "href", "type": { "text": "string" }, "description": "Forwards to href attribute of anchor element", "attribute": "href", "reflects": true }, { "kind": "field", "name": "target", "type": { "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\"" }, "description": "Tells the browser where to open the link", "attribute": "target" }, { "kind": "method", "name": "emit", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "CustomEventInit" } } ], "description": "Emits a custom event with more convenient defaults.", "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } }, { "kind": "method", "name": "define", "static": true, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "elementConstructor", "default": "this" }, { "name": "options", "default": "{}", "type": { "text": "ElementDefinitionOptions" } } ], "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } } ], "attributes": [ { "name": "href", "type": { "text": "string" }, "description": "Forwards to href attribute of anchor element", "fieldName": "href" }, { "name": "target", "type": { "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\"" }, "description": "Tells the browser where to open the link", "fieldName": "target" } ], "superclass": { "name": "SgdsElement", "module": "/src/base/sgds-element" }, "deprecated": "From v3.21.0, use a native `` element directly inside `` instead. The alert component now styles slotted anchor tags automatically.", "summary": "Alert link are used within the alert's message that is passed into the default slot of ``", "tagName": "sgds-alert-link", "customElement": true, "modulePath": "src/components/Alert/sgds-alert-link.ts", "cssProperties": [], "cssParts": [], "cssStates": [], "events": [] } ], "exports": [ { "kind": "js", "name": "SgdsAlertLink", "declaration": { "name": "SgdsAlertLink", "module": "src/components/Alert/sgds-alert-link.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "SgdsAlertLink", "module": "src/components/Alert/sgds-alert-link.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/Alert/sgds-alert.ts", "declarations": [ { "kind": "class", "description": "", "name": "SgdsAlert", "slots": [ { "description": "The alert's main content.", "name": "default" }, { "description": "An icon to show in the alert. Pass in sgds-icon size=\"md\" elements.", "name": "icon" }, { "description": "An action button or link to show in the alert.", "name": "action" } ], "members": [ { "kind": "field", "name": "show", "type": { "text": "boolean" }, "default": "false", "description": "Controls the appearance of the alert", "attribute": "show", "reflects": true }, { "kind": "field", "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "Enables a close button that allows the user to dismiss the alert.", "attribute": "dismissible", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "\"info\" | \"success\" | \"danger\" | \"warning\" | \"neutral\"" }, "default": "\"info\"", "description": "The alert's theme variant.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Controls the alert visual between a lighter outline and a solid darker variant.", "attribute": "outlined", "reflects": true }, { "kind": "field", "name": "title", "type": { "text": "string" }, "default": "\"\"", "description": "The title of the alert. Only text is allowed", "attribute": "title", "reflects": true }, { "kind": "method", "name": "close", "privacy": "public", "description": "Closes the alert", "type": {} }, { "kind": "method", "name": "emit", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "CustomEventInit" } } ], "description": "Emits a custom event with more convenient defaults.", "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } }, { "kind": "method", "name": "define", "static": true, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "elementConstructor", "default": "this" }, { "name": "options", "default": "{}", "type": { "text": "ElementDefinitionOptions" } } ], "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } } ], "events": [ { "description": "Emitted when the alert appears.", "name": "sgds-show", "reactName": "onSgdsShow" }, { "description": "Emitted after the alert closes.", "name": "sgds-hide", "reactName": "onSgdsHide" } ], "attributes": [ { "name": "show", "type": { "text": "boolean" }, "default": "false", "description": "Controls the appearance of the alert", "fieldName": "show" }, { "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "Enables a close button that allows the user to dismiss the alert.", "fieldName": "dismissible" }, { "name": "variant", "type": { "text": "AlertVariant" }, "default": "\"info\"", "description": "The alert's theme variant.", "fieldName": "variant" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Controls the alert visual between a lighter outline and a solid darker variant.", "fieldName": "outlined" }, { "name": "title", "type": { "text": "string" }, "default": "\"\"", "description": "The title of the alert. Only text is allowed", "fieldName": "title" } ], "superclass": { "name": "SgdsElement", "module": "/src/base/sgds-element" }, "summary": "Alerts provide short, timely, and relevant information for your users. It can be a simple text message or customised HTML content with paragraphs, headings and links.", "tagName": "sgds-alert", "customElement": true, "modulePath": "src/components/Alert/sgds-alert.ts", "cssProperties": [], "cssParts": [], "cssStates": [] } ], "exports": [ { "kind": "js", "name": "SgdsAlert", "declaration": { "name": "SgdsAlert", "module": "src/components/Alert/sgds-alert.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "SgdsAlert", "module": "src/components/Alert/sgds-alert.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/Badge/sgds-badge.ts", "declarations": [ { "kind": "class", "description": "", "name": "SgdsBadge", "slots": [ { "description": "slot for badge", "name": "default" }, { "description": "The slot for icon to the left of the badge text", "name": "icon" } ], "members": [ { "kind": "field", "name": "show", "type": { "text": "boolean" }, "default": "false", "description": "Controls the appearance of the dismissible badge. This prop only applies when dismissible is true", "attribute": "show", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "\"primary\" | \"accent\" | \"success\" | \"danger\" | \"warning\" | \"cyan\" | \"purple\" | \"neutral\" | \"white\" | \"info\"" }, "default": "\"primary\"", "description": "One or more badge variant combinations.\nVariants include: `primary`, `accent`, `success`, `danger`, `warning`, `cyan`, `purple`, `neutral`, `white`, `info`.\n\n(@deprecated) The `info` variant is deprecated. Use `primary` instead.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Manually set the outlined state to false", "attribute": "outlined", "reflects": true }, { "kind": "field", "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "Manually set the dismissible state of the button to `false`", "attribute": "dismissible", "reflects": true }, { "kind": "field", "name": "fullWidth", "type": { "text": "boolean" }, "default": "false", "description": "Manually enable full width", "attribute": "fullWidth", "reflects": true }, { "kind": "field", "name": "truncated", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "text", "type": { "text": "string" }, "privacy": "private", "default": "\"\"" }, { "kind": "method", "name": "close", "privacy": "public", "description": "Closes the badge", "type": {} }, { "kind": "method", "name": "_handleLabelSlotChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "type": {} }, { "kind": "method", "name": "_renderBadge", "privacy": "private", "type": {} }, { "kind": "method", "name": "emit", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "CustomEventInit" } } ], "description": "Emits a custom event with more convenient defaults.", "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } }, { "kind": "method", "name": "define", "static": true, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "elementConstructor", "default": "this" }, { "name": "options", "default": "{}", "type": { "text": "ElementDefinitionOptions" } } ], "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } } ], "events": [ { "description": "Emitted when the badge appears.", "name": "sgds-show", "reactName": "onSgdsShow" }, { "description": "Emitted when the badge is starting to close but has not closed.", "name": "sgds-hide", "reactName": "onSgdsHide" }, { "description": "Emitted after the badge has appeared", "name": "sgds-after-show", "reactName": "onSgdsAfterShow" }, { "description": "Emitted after the badge has closed", "name": "sgds-after-hide", "reactName": "onSgdsAfterHide" } ], "attributes": [ { "name": "show", "type": { "text": "boolean" }, "default": "false", "description": "Controls the appearance of the dismissible badge. This prop only applies when dismissible is true", "fieldName": "show" }, { "name": "variant", "type": { "text": "BadgeVariant" }, "default": "\"primary\"", "description": "One or more badge variant combinations.\nVariants include: `primary`, `accent`, `success`, `danger`, `warning`, `cyan`, `purple`, `neutral`, `white`, `info`.\n\n(@deprecated) The `info` variant is deprecated. Use `primary` instead.", "fieldName": "variant" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Manually set the outlined state to false", "fieldName": "outlined" }, { "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "Manually set the dismissible state of the button to `false`", "fieldName": "dismissible" }, { "name": "fullWidth", "type": { "text": "boolean" }, "default": "false", "description": "Manually enable full width", "fieldName": "fullWidth" } ], "superclass": { "name": "SgdsElement", "module": "/src/base/sgds-element" }, "summary": "Badges can be used to highlight important bits of information such as labels, notifications & status.\nWhen the text exceeds the width, it will be truncated with a tooltip that will be displayed on hover.", "tagName": "sgds-badge", "customElement": true, "modulePath": "src/components/Badge/sgds-badge.ts", "cssProperties": [], "cssParts": [], "cssStates": [] } ], "exports": [ { "kind": "js", "name": "SgdsBadge", "declaration": { "name": "SgdsBadge", "module": "src/components/Badge/sgds-badge.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "SgdsBadge", "module": "src/components/Badge/sgds-badge.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/Breadcrumb/sgds-breadcrumb-item.ts", "declarations": [ { "kind": "class", "description": "", "name": "SgdsBreadcrumbItem", "slots": [ { "description": "The link of the item. Pass in anchor tags into this slot", "name": "default" } ], "members": [ { "kind": "field", "name": "dependencies", "type": { "text": "Record" }, "static": true, "default": "{\n \"sgds-link\": SgdsLink,\n \"sgds-icon\": SgdsIcon\n }" }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item", "attribute": "active", "reflects": true }, { "kind": "field", "name": "_preventNavigation", "privacy": "private", "type": {} }, { "kind": "method", "name": "emit", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "CustomEventInit" } } ], "description": "Emits a custom event with more convenient defaults.", "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } }, { "kind": "method", "name": "define", "static": true, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "elementConstructor", "default": "this" }, { "name": "options", "default": "{}", "type": { "text": "ElementDefinitionOptions" } } ], "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } } ], "attributes": [ { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item", "fieldName": "active" } ], "superclass": { "name": "SgdsElement", "module": "/src/base/sgds-element" }, "summary": "Breadcrumb Item are navigational links used in Breadcrumb component", "tagName": "sgds-breadcrumb-item", "customElement": true, "modulePath": "src/components/Breadcrumb/sgds-breadcrumb-item.ts", "cssProperties": [], "cssParts": [], "cssStates": [], "events": [] } ], "exports": [ { "kind": "js", "name": "SgdsBreadcrumbItem", "declaration": { "name": "SgdsBreadcrumbItem", "module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "SgdsBreadcrumbItem", "module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/Breadcrumb/sgds-breadcrumb.ts", "declarations": [ { "kind": "class", "description": "", "name": "SgdsBreadcrumb", "slots": [ { "description": "The slot to pass in custom elements of `SgdsBreadcrumbItems`.", "name": "default" } ], "members": [ { "kind": "field", "name": "dependencies", "type": { "text": "object" }, "static": true, "default": "{\n \"sgds-overflow-menu\": SgdsOverflowMenu\n }" }, { "kind": "field", "name": "ariaLabel", "type": { "text": "string" }, "default": "\"breadcrumb\"", "description": "The aria-label of nav element within breadcrumb component.", "attribute": "ariaLabel" }, { "kind": "method", "name": "_replaceExcessItemsWithDropdown", "privacy": "private", "parameters": [ { "name": "items", "type": { "text": "SgdsBreadcrumbItem[]" } } ], "description": "creates `\n \n \n ...\n \n `", "type": {} }, { "kind": "method", "name": "_handleSlotChange", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "type": {} }, { "kind": "method", "name": "emit", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "CustomEventInit" } } ], "description": "Emits a custom event with more convenient defaults.", "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } }, { "kind": "method", "name": "define", "static": true, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "elementConstructor", "default": "this" }, { "name": "options", "default": "{}", "type": { "text": "ElementDefinitionOptions" } } ], "type": {}, "inheritedFrom": { "name": "SgdsElement", "module": "src/base/sgds-element.ts" } } ], "attributes": [ { "name": "ariaLabel", "type": { "text": "string" }, "default": "\"breadcrumb\"", "description": "The aria-label of nav element within breadcrumb component.", "fieldName": "ariaLabel" } ], "superclass": { "name": "SgdsElement", "module": "/src/base/sgds-element" }, "summary": "Breadcrumbs help users to navigate and understand where they are on the current website or service.", "tagName": "sgds-breadcrumb", "customElement": true, "modulePath": "src/components/Breadcrumb/sgds-breadcrumb.ts", "cssProperties": [], "cssParts": [], "cssStates": [], "events": [] } ], "exports": [ { "kind": "js", "name": "SgdsBreadcrumb", "declaration": { "name": "SgdsBreadcrumb", "module": "src/components/Breadcrumb/sgds-breadcrumb.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "SgdsBreadcrumb", "module": "src/components/Breadcrumb/sgds-breadcrumb.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/Button/sgds-button.ts", "declarations": [ { "kind": "class", "description": "", "name": "SgdsButton", "slots": [ { "description": "The button's label.", "name": "default" }, { "description": "The slot for icon to the left of the button text", "name": "leftIcon" }, { "description": "The slot for icon to the right of the button text", "name": "rightIcon" } ], "members": [ { "kind": "field", "name": "type", "type": { "text": "\"button\" | \"submit\" | \"reset\"" }, "default": "\"button\"", "description": "The behavior of the button with default as `type='button', `reset` resets all the controls to their initial values and `submit` submits the form data to the server", "attribute": "type", "reflects": true }, { "kind": "field", "name": "form", "type": { "text": "string" }, "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.", "attribute": "form", "reflects": true }, { "kind": "field", "name": "formAction", "type": { "text": "string" }, "description": "Used to override the form owner's `action` attribute.", "attribute": "formaction", "reflects": true }, { "kind": "field", "name": "formMethod", "type": { "text": "\"post\" | \"get\"" }, "description": "Used to override the form owner's `method` attribute.", "attribute": "formmethod", "reflects": true }, { "kind": "field", "name": "formNoValidate", "type": { "text": "boolean" }, "description": "Used to override the form owner's `novalidate` attribute.", "attribute": "formnovalidate", "reflects": true }, { "kind": "field", "name": "formTarget", "type": { "text": "| \"_self\"\n | \"_blank\"\n | \"_parent\"\n | \"_top\"\n | string" }, "description": "Used to override the form owner's `target` attribute.", "attribute": "formtarget", "reflects": true }, { "kind": "field", "name": "fullWidth", "type": { "text": "boolean" }, "default": "false", "description": "When set, the button will be in full width.", "attribute": "fullWidth", "reflects": true }, { "kind": "field", "name": "hasLeftIconSlot", "type": { "text": "boolean" }, "default": "false", "description": "Used only for SSR to indicate the presence of the `leftIcon` slot.", "attribute": "hasLeftIconSlot" }, { "kind": "field", "name": "hasRightIconSlot", "type": { "text": "boolean" }, "default": "false", "description": "Used only for SSR to indicate the presence of the `rightIcon` slot.", "attribute": "hasRightIconSlot" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "default": "new HasSlotController(this, \"leftIcon\", \"rightIcon\")", "type": {} }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "MouseEvent" } } ], "type": {}, "inheritedFrom": { "name": "ButtonElement", "module": "src/base/button-element.ts" } }, { "kind": "field", "name": "_clickHandler", "privacy": "private", "type": {} }, { "kind": "field", "name": "variant", "type": { "text": "\"primary\" | \"outline\" | \"ghost\" | \"danger\"" }, "default": "\"primary\"", "description": "Sets the visual variants such as: `primary`, `outline`, `ghost`. `danger` is @deprecated since v3.5.6", "attribute": "variant", "reflects": true, "inheritedFrom": { "name": "ButtonElement", "module": "src/base/button-element.ts" } }, { "kind": "field", "name": "tone", "type": { "text": "\"brand\" | \"danger\" | \"fixed-light\" | \"neutral\"" }, "default": "\"brand\"", "description": "Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral`", "attribute": "tone", "reflects": true, "inheritedFrom": { "name": "ButtonElement", "module": "src/base/button-element.ts" } }, { "kind": "field", "name": "size", "type": { "text": "\"xs\" | \"sm\" | \"md\" | \"lg\"" }, "default": "\"md\"", "description": "Specifies a small, medium or large button, the size is medium by default.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "ButtonElement", "module": "src/base/button-element.ts" } }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Manually set the visual state of the button to `:active`", "attribute": "active", "reflects": true, "inheritedFrom": { "name": "ButtonElement", "module": "src/base/button-element.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "The disabled state of the button", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "ButtonElement", "module": "src/base/button-element.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string" }, "description": "When set, the underlying button will be rendered as an `` with this `href` instead of a `