{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "setup-jest.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "build-scripts/generate-react.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "build-scripts/tokens-color.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/gds-element.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/utils/helpers/custom-element-scoping" } } ] }, { "kind": "javascript-module", "path": "src/localization.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/utils/localization/localization" } } ] }, { "kind": "javascript-module", "path": "src/pure.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/listbox/option.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/menu/menu-heading.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/menu/menu-item.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/alert/alert.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/badge/badge.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/blur/blur.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/breadcrumbs/breadcrumbs.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/breadcrumbs/breadcrumb/breadcrumb.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/button/button.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/calendar/calendar.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/card/card.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/card-linked/card-linked.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/checkbox/checkbox-group/checkbox-group.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/checkbox/checkbox.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/coachmark/coachmark.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/context-menu/context-menu.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/datepicker/datepicker.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/details/details.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/dialog/dialog.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/div/div.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/divider/divider.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/dropdown/dropdown.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/fab/fab.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/filter-chips/filter-chips.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/flex/flex.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/form-summary/summary.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/grid/grid.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/grouped-list/grouped-list.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icon.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pure" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/img/img.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/input/input.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/link/link.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/mask/mask.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/menu-button/menu-button.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/pagination/pagination.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/popover/popover.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/radio/radio-group/radio-group.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/radio/radio.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/rich-text/rich-text.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/segmented-control/segmented-control.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/sensitive/number/sensitive-number.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/sensitive/date/sensitive-date.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/sensitive/account/sensitive-account.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/select/select.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/signal/signal.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/spinner/spinner.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/text/text.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/table/table.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/textarea/textarea.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/theme/theme.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/video/video.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/patterns/card-pattern-01/card-pattern-01.component" } } ] }, { "kind": "javascript-module", "path": "src/scoping.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/utils/helpers/custom-element-scoping" } } ] }, { "kind": "javascript-module", "path": "src/test-setup.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/tokens.style.ts", "declarations": [ { "kind": "variable", "name": "tokens", "type": { "text": "array" }, "default": "[ css` :host { ${unsafeCSS(base)} ${unsafeCSS(shadows)} } `, ]" } ], "exports": [ { "kind": "js", "name": "tokens", "declaration": { "name": "tokens", "module": "src/tokens.style.ts" } }, { "kind": "js", "name": "colorsLight", "declaration": { "name": "colorsLight", "module": "src/tokens.style.ts" } }, { "kind": "js", "name": "colorsDark", "declaration": { "name": "colorsDark", "module": "src/tokens.style.ts" } } ] }, { "kind": "javascript-module", "path": "src/transitional-styles.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/utils/transitional-styles/transitional-styles" } } ] }, { "kind": "javascript-module", "path": "build-scripts/mcp/extract-tokens.ts", "declarations": [ { "kind": "variable", "name": "content", "default": "await fs.readFile(filePath, 'utf-8')" }, { "kind": "function", "name": "extractTokens", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "outputPath", "type": { "text": "string" } } ] } ], "exports": [ { "kind": "js", "name": "extractTokens", "declaration": { "name": "extractTokens", "module": "build-scripts/mcp/extract-tokens.ts" } } ] }, { "kind": "javascript-module", "path": "build-scripts/mcp/generate-mcp-data.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "build-scripts/mcp/generate-mcp-data.types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/generated/locale-codes.ts", "declarations": [ { "kind": "variable", "name": "sourceLocale", "default": "`en`", "description": "The locale code that templates in this source code are written in." }, { "kind": "variable", "name": "targetLocales", "type": { "text": "[\n `da`,\n `de`,\n `fi`,\n `fr`,\n `it`,\n `nl`,\n `no`,\n `sv`,\n]" }, "default": "[ `da`, `de`, `fi`, `fr`, `it`, `nl`, `no`, `sv`, ]", "description": "The other locale codes that this application is localized into. Sorted\nlexicographically." }, { "kind": "variable", "name": "allLocales", "type": { "text": "[\n `da`,\n `de`,\n `en`,\n `fi`,\n `fr`,\n `it`,\n `nl`,\n `no`,\n `sv`,\n]" }, "default": "[ `da`, `de`, `en`, `fi`, `fr`, `it`, `nl`, `no`, `sv`, ]", "description": "All valid project locale codes. Sorted lexicographically." } ], "exports": [ { "kind": "js", "name": "sourceLocale", "declaration": { "name": "sourceLocale", "module": "src/generated/locale-codes.ts" } }, { "kind": "js", "name": "targetLocales", "declaration": { "name": "targetLocales", "module": "src/generated/locale-codes.ts" } }, { "kind": "js", "name": "allLocales", "declaration": { "name": "allLocales", "module": "src/generated/locale-codes.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/patterns/card-pattern-01/card-pattern-01" } } ] }, { "kind": "javascript-module", "path": "src/components/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/listbox/option" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/menu/menu-heading" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/menu/menu-item" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/alert" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/badge" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/blur" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/breadcrumbs" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/button" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/card/card" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/card-linked/card-linked" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/checkbox" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/coachmark" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/context-menu" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/datepicker" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/details" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/dialog" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/div" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/divider" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/dropdown" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/fab" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/filter-chips" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/flex/flex" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/form" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/grid/grid" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/grouped-list" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icon" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/img" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/input" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/link" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/mask" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/menu-button" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/pagination" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/popover" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/radio" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/rich-text" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/segmented-control" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/select" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/signal" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/spinner" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/text" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/table" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/textarea" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/theme" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/video" } } ] }, { "kind": "javascript-module", "path": "src/shared-styles/form-control-host.style.ts", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "module": "src/shared-styles/form-control-host.style.ts" } } ] }, { "kind": "javascript-module", "path": "src/shared-styles/rbcb-toggle.style.ts", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "module": "src/shared-styles/rbcb-toggle.style.ts" } } ] }, { "kind": "javascript-module", "path": "src/shared-styles/rbcb-toggle.template.ts", "declarations": [ { "kind": "function", "name": "checkboxToggle", "parameters": [ { "name": "props", "type": { "text": "Omit" } } ], "description": "Renders a checkbox toggle." }, { "kind": "function", "name": "radioToggle", "parameters": [ { "name": "props", "type": { "text": "Omit" } } ], "description": "Renders a radio toggle." } ], "exports": [ { "kind": "js", "name": "checkboxToggle", "declaration": { "name": "checkboxToggle", "module": "src/shared-styles/rbcb-toggle.template.ts" } }, { "kind": "js", "name": "radioToggle", "declaration": { "name": "radioToggle", "module": "src/shared-styles/rbcb-toggle.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/global-styles.ts", "declarations": [ { "kind": "class", "description": "GlobalStylesRegistry is a singleton class that manages global stylesheets in the document.\nThe singleton is used to inject global styles that are not scoped to specific components.", "name": "GlobalStylesRegistry", "members": [ { "kind": "field", "name": "instance", "static": true, "description": "Get the global singleton instance of the GlobalStylesRegistry.", "readonly": true }, { "kind": "method", "name": "injectGlobalStyles", "parameters": [ { "name": "key", "type": { "text": "string" }, "description": "unique identifier for this stylesheet." }, { "name": "styles", "type": { "text": "CSSResult" }, "description": "CSSResult produced by the lit css template literal tag" } ], "description": "Injects global styles into the document. This function is intended to be used for global styles\nthat cannot be scoped to a specific component." }, { "kind": "method", "name": "clearGlobalStyles", "parameters": [ { "name": "key", "type": { "text": "string" }, "description": "unique identifier for the stylesheet to be removed." } ], "description": "Clears global styles for the given key." } ] } ], "exports": [ { "kind": "js", "name": "GlobalStylesRegistry", "declaration": { "name": "GlobalStylesRegistry", "module": "src/utils/global-styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/react.ts", "declarations": [ { "kind": "function", "name": "getReactComponent", "parameters": [ { "name": "tagName", "type": { "text": "string" } } ], "description": "Get a React 19 compatible component from a GDS component" }, { "kind": "function", "name": "useControlledValue", "parameters": [ { "name": "elementRef", "type": { "text": "React.RefObject" } }, { "name": "value", "type": { "text": "any" } }, { "name": "defaultValue", "type": { "text": "any" } }, { "name": "onChange", "optional": true, "type": { "text": "(event: any) => void" } }, { "name": "onInput", "optional": true, "type": { "text": "(event: any) => void" } } ], "description": "Hook to implement controlled component behavior for form controls with a value property" }, { "kind": "function", "name": "useControlledChecked", "parameters": [ { "name": "elementRef", "type": { "text": "React.RefObject" } }, { "name": "checked", "type": { "text": "boolean | undefined" } }, { "name": "defaultChecked", "type": { "text": "boolean | undefined" } }, { "name": "onChange", "optional": true, "type": { "text": "(event: any) => void" } }, { "name": "onInput", "optional": true, "type": { "text": "(event: any) => void" } } ], "description": "Hook to implement controlled component behavior for checkbox form controls with a checked property" } ], "exports": [ { "kind": "js", "name": "getReactComponent", "declaration": { "name": "getReactComponent", "module": "src/utils/react.ts" } }, { "kind": "js", "name": "useControlledValue", "declaration": { "name": "useControlledValue", "module": "src/utils/react.ts" } }, { "kind": "js", "name": "useControlledChecked", "declaration": { "name": "useControlledChecked", "module": "src/utils/react.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/framework.ts", "declarations": [ { "kind": "variable", "name": "DOCS_FRAMEWORK_CANONICAL", "type": { "text": "[\n 'angular',\n 'react',\n 'web-component',\n]" }, "default": "[ 'angular', 'react', 'web-component', ]" }, { "kind": "function", "name": "normalizeDocsFramework", "return": { "type": { "text": "DocsFramework | null" } }, "parameters": [ { "name": "input", "type": { "text": "string" } } ] } ], "exports": [ { "kind": "js", "name": "DOCS_FRAMEWORK_CANONICAL", "declaration": { "name": "DOCS_FRAMEWORK_CANONICAL", "module": "src/bin/context-cli/framework.ts" } }, { "kind": "js", "name": "normalizeDocsFramework", "declaration": { "name": "normalizeDocsFramework", "module": "src/bin/context-cli/framework.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/index.ts", "declarations": [ { "kind": "variable", "name": "query", "default": "args.positional[0]" } ], "exports": [ { "kind": "js", "name": "parseArgs", "declaration": { "name": "parseArgs", "module": "./parse-args.js" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/parse-args.ts", "declarations": [ { "kind": "function", "name": "parseArgs", "return": { "type": { "text": "" } }, "parameters": [ { "name": "argv", "type": { "text": "string[]" }, "description": "Raw argument array (typically process.argv.slice(2))" } ], "description": "Parse process.argv into a structured object.\n\nSupports:\n- Positional arguments\n- Long flags: --flag, --flag value, --flag=value\n- Short flags: -h, -v\n- Boolean negation: --no- → flag = false" } ], "exports": [ { "kind": "js", "name": "parseArgs", "declaration": { "name": "parseArgs", "module": "src/bin/context-cli/parse-args.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/mcp-server/constants.ts", "declarations": [ { "kind": "variable", "name": "SERVER_CONFIG", "type": { "text": "{\n /** Server name used in MCP protocol */\n SERVER_NAME: 'green-design-system',\n /** Fallback version if package.json cannot be read */\n DEFAULT_VERSION: '0.0.0',\n}" }, "default": "{ /** Server name used in MCP protocol */ SERVER_NAME: 'green-design-system', /** Fallback version if package.json cannot be read */ DEFAULT_VERSION: '0.0.0', }", "description": "Server configuration constants" }, { "kind": "variable", "name": "SEARCH_CONFIG", "type": { "text": "{\n /** Maximum length for regex patterns to prevent ReDoS attacks */\n MAX_REGEX_LENGTH: 100,\n /** Default maximum number of search results to return */\n DEFAULT_MAX_RESULTS: 20,\n /** Minimum query length required for search */\n MIN_QUERY_LENGTH: 1,\n}" }, "default": "{ /** Maximum length for regex patterns to prevent ReDoS attacks */ MAX_REGEX_LENGTH: 100, /** Default maximum number of search results to return */ DEFAULT_MAX_RESULTS: 20, /** Minimum query length required for search */ MIN_QUERY_LENGTH: 1, }", "description": "Search configuration constants" }, { "kind": "variable", "name": "SEARCH_TIERS", "type": { "text": "{\n /** Exact match with tag name (e.g., \"gds-button\" matches \"gds-button\") */\n EXACT_MATCH: 1,\n /** Tag name starts with search term (e.g., \"button\" matches \"gds-button-group\") */\n STARTS_WITH: 2,\n /** Tag name contains search term (e.g., \"button\" matches \"gds-radio-button\") */\n TAG_CONTAINS: 3,\n /** Name or className contains search term */\n NAME_CONTAINS: 4,\n /** Description contains search term */\n DESCRIPTION_CONTAINS: 5,\n}" }, "default": "{ /** Exact match with tag name (e.g., \"gds-button\" matches \"gds-button\") */ EXACT_MATCH: 1, /** Tag name starts with search term (e.g., \"button\" matches \"gds-button-group\") */ STARTS_WITH: 2, /** Tag name contains search term (e.g., \"button\" matches \"gds-radio-button\") */ TAG_CONTAINS: 3, /** Name or className contains search term */ NAME_CONTAINS: 4, /** Description contains search term */ DESCRIPTION_CONTAINS: 5, }", "description": "Search result tier priorities (lower number = better match)\nUsed to rank search results by relevance" }, { "kind": "variable", "name": "PATHS", "type": { "text": "{\n /** Name of the root instructions file */\n INSTRUCTIONS_FILE: 'INSTRUCTIONS.md',\n /** Components index file name */\n COMPONENTS_INDEX: 'components.json',\n /** Icons index file name */\n ICONS_INDEX: 'icons.json',\n /** Global index file name */\n GLOBAL_INDEX: 'index.json',\n /** Tokens index file name */\n TOKENS_INDEX: 'tokens.json',\n /** Package.json file name */\n PACKAGE_JSON: 'package.json',\n}" }, "default": "{ /** Name of the root instructions file */ INSTRUCTIONS_FILE: 'INSTRUCTIONS.md', /** Components index file name */ COMPONENTS_INDEX: 'components.json', /** Icons index file name */ ICONS_INDEX: 'icons.json', /** Global index file name */ GLOBAL_INDEX: 'index.json', /** Tokens index file name */ TOKENS_INDEX: 'tokens.json', /** Package.json file name */ PACKAGE_JSON: 'package.json', }", "description": "File and path constants" }, { "kind": "variable", "name": "URI_SCHEME", "type": { "text": "{\n /** Protocol scheme for Green resources */\n SCHEME: 'green://',\n /** Instructions resource URI */\n INSTRUCTIONS: 'green://instructions',\n}" }, "default": "{ /** Protocol scheme for Green resources */ SCHEME: 'green://', /** Instructions resource URI */ INSTRUCTIONS: 'green://instructions', }", "description": "URI scheme for Green resources" }, { "kind": "variable", "name": "PREFIXES", "type": { "text": "{\n /** Standard component prefix */\n COMPONENT: 'gds-',\n /** Icon component prefix */\n ICON: 'gds-icon-',\n}" }, "default": "{ /** Standard component prefix */ COMPONENT: 'gds-', /** Icon component prefix */ ICON: 'gds-icon-', }", "description": "Component prefixes" }, { "kind": "variable", "name": "FRAMEWORKS", "type": { "text": "['angular', 'react', 'web-component']" }, "default": "['angular', 'react', 'web-component']", "description": "Framework types" }, { "kind": "variable", "name": "CATEGORIES", "type": { "text": "['component', 'icon', 'all']" }, "default": "['component', 'icon', 'all']", "description": "Category types" }, { "kind": "variable", "name": "GUIDE_CATEGORIES", "type": { "text": "[\n 'framework-setup',\n 'getting-started',\n 'concepts',\n 'troubleshooting',\n 'migration',\n 'all',\n]" }, "default": "[ 'framework-setup', 'getting-started', 'concepts', 'troubleshooting', 'migration', 'all', ]", "description": "Guide categories" }, { "kind": "variable", "name": "TOKEN_CATEGORIES", "type": { "text": "[\n 'space',\n 'radius',\n 'color',\n 'typography',\n 'viewport',\n 'shadow',\n 'motion',\n 'all',\n]" }, "default": "[ 'space', 'radius', 'color', 'typography', 'viewport', 'shadow', 'motion', 'all', ]", "description": "Token categories" }, { "kind": "variable", "name": "COLOR_SUBCATEGORIES", "type": { "text": "[\n 'background',\n 'border',\n 'content',\n 'state',\n 'all',\n]" }, "default": "[ 'background', 'border', 'content', 'state', 'all', ]", "description": "Color subcategories" }, { "kind": "variable", "name": "DOC_TYPES", "type": { "text": "{\n /** Web Component API documentation */\n API: 'api',\n /** Angular-specific documentation */\n ANGULAR: 'angular',\n /** React-specific documentation */\n REACT: 'react',\n /** UX and design guidelines */\n GUIDELINES: 'guidelines',\n /** Agent-specific usage instructions */\n INSTRUCTIONS: 'instructions',\n}" }, "default": "{ /** Web Component API documentation */ API: 'api', /** Angular-specific documentation */ ANGULAR: 'angular', /** React-specific documentation */ REACT: 'react', /** UX and design guidelines */ GUIDELINES: 'guidelines', /** Agent-specific usage instructions */ INSTRUCTIONS: 'instructions', }", "description": "Documentation types available for components" } ], "exports": [ { "kind": "js", "name": "SERVER_CONFIG", "declaration": { "name": "SERVER_CONFIG", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "SEARCH_CONFIG", "declaration": { "name": "SEARCH_CONFIG", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "SEARCH_TIERS", "declaration": { "name": "SEARCH_TIERS", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "PATHS", "declaration": { "name": "PATHS", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "URI_SCHEME", "declaration": { "name": "URI_SCHEME", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "PREFIXES", "declaration": { "name": "PREFIXES", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "FRAMEWORKS", "declaration": { "name": "FRAMEWORKS", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "CATEGORIES", "declaration": { "name": "CATEGORIES", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "GUIDE_CATEGORIES", "declaration": { "name": "GUIDE_CATEGORIES", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "TOKEN_CATEGORIES", "declaration": { "name": "TOKEN_CATEGORIES", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "COLOR_SUBCATEGORIES", "declaration": { "name": "COLOR_SUBCATEGORIES", "module": "src/bin/mcp-server/constants.ts" } }, { "kind": "js", "name": "DOC_TYPES", "declaration": { "name": "DOC_TYPES", "module": "src/bin/mcp-server/constants.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/mcp-server/errors.ts", "declarations": [ { "kind": "class", "description": "Base error class for MCP server errors\nProvides structured error information for better debugging and error handling", "name": "McpError", "members": [ { "kind": "method", "name": "toJSON", "return": { "type": { "text": "Record" } }, "description": "Convert error to JSON representation" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "'McpError'" } ], "superclass": { "name": "Error", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "class", "description": "Error thrown when input validation fails", "name": "ValidationError", "members": [ { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "'ValidationError'", "inheritedFrom": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "method", "name": "toJSON", "return": { "type": { "text": "Record" } }, "description": "Convert error to JSON representation", "inheritedFrom": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } } ], "superclass": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "class", "description": "Error thrown when a resource is not found", "name": "NotFoundError", "members": [ { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "'NotFoundError'", "inheritedFrom": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "method", "name": "toJSON", "return": { "type": { "text": "Record" } }, "description": "Convert error to JSON representation", "inheritedFrom": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } } ], "superclass": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "class", "description": "Error thrown when data loading fails", "name": "DataLoadError", "members": [ { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "'DataLoadError'", "inheritedFrom": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "method", "name": "toJSON", "return": { "type": { "text": "Record" } }, "description": "Convert error to JSON representation", "inheritedFrom": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } } ], "superclass": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "class", "description": "Error thrown when a regex pattern is invalid", "name": "RegexError", "members": [ { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "'RegexError'", "inheritedFrom": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "method", "name": "toJSON", "return": { "type": { "text": "Record" } }, "description": "Convert error to JSON representation", "inheritedFrom": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } } ], "superclass": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "function", "name": "formatErrorResponse", "return": { "type": { "text": "" } }, "parameters": [ { "name": "error", "type": { "text": "unknown" }, "description": "The error to convert" } ], "description": "Convert any error to an MCP error response format" }, { "kind": "function", "name": "logError", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "error", "type": { "text": "unknown" }, "description": "The error to log" }, { "name": "operation", "type": { "text": "string" }, "description": "The operation that failed" } ], "description": "Log error with structured information" } ], "exports": [ { "kind": "js", "name": "McpError", "declaration": { "name": "McpError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "js", "name": "ValidationError", "declaration": { "name": "ValidationError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "js", "name": "NotFoundError", "declaration": { "name": "NotFoundError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "js", "name": "DataLoadError", "declaration": { "name": "DataLoadError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "js", "name": "RegexError", "declaration": { "name": "RegexError", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "js", "name": "formatErrorResponse", "declaration": { "name": "formatErrorResponse", "module": "src/bin/mcp-server/errors.ts" } }, { "kind": "js", "name": "logError", "declaration": { "name": "logError", "module": "src/bin/mcp-server/errors.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/mcp-server/handlers.ts", "declarations": [ { "kind": "function", "name": "handleSearchComponents", "return": { "type": { "text": "" } }, "parameters": [ { "name": "input", "type": { "text": "unknown" }, "description": "Raw input object (validated internally)" } ], "description": "Handle search_components — search for components and icons by name,\ndescription, or functionality." }, { "kind": "function", "name": "handleGetComponentDocs", "return": { "type": { "text": "" } }, "parameters": [ { "name": "input", "type": { "text": "unknown" }, "description": "Raw input object (validated internally)" } ], "description": "Handle get_component_docs — retrieve full documentation for a specific\ncomponent, including framework-specific imports, API reference, design\nguidelines, and agent usage instructions." }, { "kind": "function", "name": "handleListGuides", "return": { "type": { "text": "" } }, "parameters": [ { "name": "input", "type": { "text": "unknown" }, "description": "Raw input object (validated internally)" } ], "description": "Handle list_guides — list available setup guides and conceptual\ndocumentation, optionally filtered by category and framework." }, { "kind": "function", "name": "handleGetGuide", "return": { "type": { "text": "" } }, "parameters": [ { "name": "input", "type": { "text": "unknown" }, "description": "Raw input object (validated internally)" } ], "description": "Handle get_guide — retrieve the full content of a specific guide." }, { "kind": "function", "name": "handleGetInstructions", "return": { "type": { "text": "" } }, "description": "Handle get_instructions — retrieve the base instructions document\ncontaining critical rules, typography guidelines, layout system\nrequirements, and general best practices." }, { "kind": "function", "name": "handleResolveUri", "return": { "type": { "text": "" } }, "parameters": [ { "name": "uri", "type": { "text": "string" }, "description": "A green:// resource URI string" } ], "description": "Handle URI resolution — read the raw content of a green:// resource URI.\n\nSupports all URI types:\n- green://components/{name}/{docType} (e.g. green://components/button/api)\n- green://icons/{name}/{docType} (e.g. green://icons/arrow/api)\n- green://guides/{name} (e.g. green://guides/angular)\n- green://concepts/{name} (e.g. green://concepts/tokens)\n- green://instructions (the root instructions document)" }, { "kind": "function", "name": "handleGetTokens", "return": { "type": { "text": "" } }, "parameters": [ { "name": "input", "type": { "text": "unknown" }, "description": "Raw input object (validated internally)" } ], "description": "Handle get_tokens — retrieve design token information, optionally\nfiltered by category and color subcategory." } ], "exports": [ { "kind": "js", "name": "handleSearchComponents", "declaration": { "name": "handleSearchComponents", "module": "src/bin/mcp-server/handlers.ts" } }, { "kind": "js", "name": "handleGetComponentDocs", "declaration": { "name": "handleGetComponentDocs", "module": "src/bin/mcp-server/handlers.ts" } }, { "kind": "js", "name": "handleListGuides", "declaration": { "name": "handleListGuides", "module": "src/bin/mcp-server/handlers.ts" } }, { "kind": "js", "name": "handleGetGuide", "declaration": { "name": "handleGetGuide", "module": "src/bin/mcp-server/handlers.ts" } }, { "kind": "js", "name": "handleGetInstructions", "declaration": { "name": "handleGetInstructions", "module": "src/bin/mcp-server/handlers.ts" } }, { "kind": "js", "name": "handleResolveUri", "declaration": { "name": "handleResolveUri", "module": "src/bin/mcp-server/handlers.ts" } }, { "kind": "js", "name": "handleGetTokens", "declaration": { "name": "handleGetTokens", "module": "src/bin/mcp-server/handlers.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/mcp-server/index.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/bin/mcp-server/resources.ts", "declarations": [ { "kind": "function", "name": "setupResourceHandlers", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "server", "type": { "text": "Server" } } ], "description": "Register resource handlers on the MCP server" } ], "exports": [ { "kind": "js", "name": "setupResourceHandlers", "declaration": { "name": "setupResourceHandlers", "module": "src/bin/mcp-server/resources.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/mcp-server/search.ts", "declarations": [ { "kind": "function", "name": "parseSearchQuery", "return": { "type": { "text": "" } }, "parameters": [ { "name": "query", "type": { "text": "string" }, "description": "Search query" }, { "name": "splitTerms", "type": { "text": "boolean" }, "description": "Whether to split query into multiple terms" }, { "name": "useRegex", "type": { "text": "boolean" }, "description": "Whether to treat query as regex" } ], "description": "Parse search query into terms or regex" }, { "kind": "function", "name": "performSearch", "return": { "type": { "text": "" } }, "parameters": [ { "name": "components", "type": { "text": "ComponentEntry[]" }, "description": "Array of component entries to search" }, { "name": "icons", "type": { "text": "IconEntry[]" }, "description": "Array of icon entries to search" }, { "name": "query", "type": { "text": "string" }, "description": "Original search query" }, { "name": "searchTerms", "type": { "text": "string[]" }, "description": "Parsed search terms" }, { "name": "regexPattern", "type": { "text": "RegExp | null" }, "description": "Optional regex pattern" }, { "name": "matchAll", "type": { "text": "boolean" }, "description": "Whether all terms must match" }, { "name": "splitTerms", "type": { "text": "boolean" }, "description": "Whether terms were split" }, { "name": "maxResults", "type": { "text": "number" }, "description": "Maximum number of results to return" }, { "name": "buildResourceUris", "type": { "text": "(\n item: ComponentEntry | IconEntry,\n category: 'component' | 'icon',\n ) => { [key: string]: string }" }, "description": "Function to build resource URIs for a match" } ], "description": "Search components and icons with tiered relevance ranking" } ], "exports": [ { "kind": "js", "name": "parseSearchQuery", "declaration": { "name": "parseSearchQuery", "module": "src/bin/mcp-server/search.ts" } }, { "kind": "js", "name": "performSearch", "declaration": { "name": "performSearch", "module": "src/bin/mcp-server/search.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/mcp-server/tools.ts", "declarations": [ { "kind": "function", "name": "setupToolHandlers", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "server", "type": { "text": "Server" } } ], "description": "Register tool handlers on the MCP server.\n\nDefines the MCP tool schemas (names, descriptions, input schemas) and\ndelegates each tool call to the corresponding shared handler function." } ], "exports": [ { "kind": "js", "name": "setupToolHandlers", "declaration": { "name": "setupToolHandlers", "module": "src/bin/mcp-server/tools.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/mcp-server/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/bin/mcp-server/utils.ts", "declarations": [ { "kind": "function", "name": "getMcpDataPath", "return": { "type": { "text": "" } }, "description": "Resolve the path to the MCP data directory\nWhen compiled: Server is at dist/libs/core/src/bin/mcp-server/\nWhen compiled: MCP data is at dist/libs/core/src/generated/mcp/" }, { "kind": "function", "name": "getPackageVersion", "return": { "type": { "text": "" } }, "description": "Read the package version from package.json at runtime" }, { "kind": "function", "name": "loadComponentsIndex", "return": { "type": { "text": "" } }, "description": "Load the components index" }, { "kind": "function", "name": "loadIconsIndex", "return": { "type": { "text": "" } }, "description": "Load the icons index" }, { "kind": "function", "name": "loadGlobalIndex", "return": { "type": { "text": "" } }, "description": "Load the global index" }, { "kind": "function", "name": "loadTokensIndex", "return": { "type": { "text": "" } }, "description": "Load the tokens index" }, { "kind": "function", "name": "normalizeComponentName", "return": { "type": { "text": "" } }, "parameters": [ { "name": "name", "type": { "text": "string" }, "description": "Component name to normalize" } ], "description": "Normalize component name for matching\nHandles both 'gds-button' and 'button' formats" }, { "kind": "function", "name": "findComponent", "return": { "type": { "text": "" } }, "parameters": [ { "name": "name", "type": { "text": "string" }, "description": "Component name to search for" }, { "name": "components", "type": { "text": "ComponentEntry[]" }, "description": "Array of component entries" } ], "description": "Find a component by name with flexible matching" }, { "kind": "function", "name": "findIcon", "return": { "type": { "text": "" } }, "parameters": [ { "name": "name", "type": { "text": "string" }, "description": "Icon name to search for" }, { "name": "icons", "type": { "text": "IconEntry[]" }, "description": "Array of icon entries" } ], "description": "Find an icon by name with flexible matching" }, { "kind": "function", "name": "readMcpFile", "return": { "type": { "text": "" } }, "parameters": [ { "name": "relativePath", "type": { "text": "string" }, "description": "Path relative to MCP data directory" } ], "description": "Read a markdown file from the MCP data directory" }, { "kind": "function", "name": "buildResourceUri", "return": { "type": { "text": "" } }, "parameters": [ { "name": "category", "type": { "text": "'components' | 'icons' | 'guides' | 'concepts'" }, "description": "Resource category" }, { "name": "name", "type": { "text": "string" }, "description": "Component/icon/guide name" }, { "name": "docType", "optional": true, "type": { "text": "string" }, "description": "Optional documentation type" } ], "description": "Build a resource URI for a component/icon documentation file" }, { "kind": "function", "name": "parseResourceUri", "return": { "type": { "text": "" } }, "parameters": [ { "name": "uri", "type": { "text": "string" }, "description": "Resource URI to parse" } ], "description": "Parse a resource URI into its components" } ], "exports": [ { "kind": "js", "name": "getMcpDataPath", "declaration": { "name": "getMcpDataPath", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "getPackageVersion", "declaration": { "name": "getPackageVersion", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "loadComponentsIndex", "declaration": { "name": "loadComponentsIndex", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "loadIconsIndex", "declaration": { "name": "loadIconsIndex", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "loadGlobalIndex", "declaration": { "name": "loadGlobalIndex", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "loadTokensIndex", "declaration": { "name": "loadTokensIndex", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "normalizeComponentName", "declaration": { "name": "normalizeComponentName", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "findComponent", "declaration": { "name": "findComponent", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "findIcon", "declaration": { "name": "findIcon", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "readMcpFile", "declaration": { "name": "readMcpFile", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "buildResourceUri", "declaration": { "name": "buildResourceUri", "module": "src/bin/mcp-server/utils.ts" } }, { "kind": "js", "name": "parseResourceUri", "declaration": { "name": "parseResourceUri", "module": "src/bin/mcp-server/utils.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/mcp-server/validation.ts", "declarations": [ { "kind": "function", "name": "validateFramework", "return": { "type": { "text": "" } }, "parameters": [ { "name": "framework", "type": { "text": "unknown" }, "description": "Framework value to validate" } ], "description": "Validate framework parameter" }, { "kind": "function", "name": "validateCategory", "return": { "type": { "text": "" } }, "parameters": [ { "name": "category", "type": { "text": "unknown" }, "description": "Category value to validate" } ], "description": "Validate category parameter" }, { "kind": "function", "name": "validateGuideCategory", "return": { "type": { "text": "" } }, "parameters": [ { "name": "category", "type": { "text": "unknown" }, "description": "Guide category value to validate" } ], "description": "Validate guide category parameter" }, { "kind": "function", "name": "validateString", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "Value to validate" }, { "name": "fieldName", "type": { "text": "string" }, "description": "Name of the field" }, { "name": "required", "default": "true", "type": { "text": "boolean" }, "description": "Whether the field is required" }, { "name": "minLength", "optional": true, "type": { "text": "number" }, "description": "Minimum length (optional)" }, { "name": "maxLength", "optional": true, "type": { "text": "number" }, "description": "Maximum length (optional)" } ], "description": "Validate string parameter" }, { "kind": "function", "name": "validateBoolean", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "Value to validate" }, { "name": "fieldName", "type": { "text": "string" }, "description": "Name of the field" }, { "name": "defaultValue", "default": "false", "type": { "text": "boolean" }, "description": "Default value if undefined" } ], "description": "Validate boolean parameter" }, { "kind": "function", "name": "validateNumber", "return": { "type": { "text": "" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" }, "description": "Value to validate" }, { "name": "fieldName", "type": { "text": "string" }, "description": "Name of the field" }, { "name": "defaultValue", "optional": true, "type": { "text": "number" }, "description": "Default value if undefined" }, { "name": "min", "optional": true, "type": { "text": "number" }, "description": "Minimum value (optional)" }, { "name": "max", "optional": true, "type": { "text": "number" }, "description": "Maximum value (optional)" } ], "description": "Validate number parameter" }, { "kind": "function", "name": "sanitizeComponentName", "return": { "type": { "text": "" } }, "parameters": [ { "name": "name", "type": { "text": "string" }, "description": "Component name to sanitize" } ], "description": "Sanitize component name to prevent path traversal" }, { "kind": "function", "name": "validateSearchComponentsInput", "return": { "type": { "text": "" } }, "parameters": [ { "name": "input", "type": { "text": "unknown" }, "description": "Input to validate" } ], "description": "Validate SearchComponentsInput" }, { "kind": "function", "name": "validateGetComponentDocsInput", "return": { "type": { "text": "" } }, "parameters": [ { "name": "input", "type": { "text": "unknown" }, "description": "Input to validate" } ], "description": "Validate GetComponentDocsInput" }, { "kind": "function", "name": "validateListGuidesInput", "return": { "type": { "text": "" } }, "parameters": [ { "name": "input", "type": { "text": "unknown" }, "description": "Input to validate" } ], "description": "Validate ListGuidesInput" }, { "kind": "function", "name": "validateGetGuideInput", "return": { "type": { "text": "" } }, "parameters": [ { "name": "input", "type": { "text": "unknown" }, "description": "Input to validate" } ], "description": "Validate GetGuideInput" }, { "kind": "function", "name": "validateGetTokensInput", "return": { "type": { "text": "" } }, "parameters": [ { "name": "input", "type": { "text": "unknown" }, "description": "Input to validate" } ], "description": "Validate GetTokensInput" } ], "exports": [ { "kind": "js", "name": "validateFramework", "declaration": { "name": "validateFramework", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "validateCategory", "declaration": { "name": "validateCategory", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "validateGuideCategory", "declaration": { "name": "validateGuideCategory", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "validateString", "declaration": { "name": "validateString", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "validateBoolean", "declaration": { "name": "validateBoolean", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "validateNumber", "declaration": { "name": "validateNumber", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "sanitizeComponentName", "declaration": { "name": "sanitizeComponentName", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "validateSearchComponentsInput", "declaration": { "name": "validateSearchComponentsInput", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "validateGetComponentDocsInput", "declaration": { "name": "validateGetComponentDocsInput", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "validateListGuidesInput", "declaration": { "name": "validateListGuidesInput", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "validateGetGuideInput", "declaration": { "name": "validateGetGuideInput", "module": "src/bin/mcp-server/validation.ts" } }, { "kind": "js", "name": "validateGetTokensInput", "declaration": { "name": "validateGetTokensInput", "module": "src/bin/mcp-server/validation.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/locales/da.ts", "declarations": [ { "kind": "variable", "name": "templates", "type": { "text": "object" }, "default": "{ 's023f114f575b5bd5': `Nuværende side`, 's038b2a0deba58916': `side`, 's03c44f5a1b0581d4': `valgt`, 's08b06007b5567108': `af`, 's09023907b59c38eb': `Gå`, 's15a16ae9f99f19bf': `Juli`, 's15a852e9f9a50fa5': `Juni`, 's1727e353c65eba61': `Ryd valgt dato`, 's17e3edbe032f79ec': `Åbn kalender-popup`, 's1910f3ebccaec414': str`${0} valgte`, 's1a2dda8f763a68bd': `Januar`, 's1e118319b5202c41': `Man`, 's1e187019b5262aa6': `Maj`, 's22237cd4f966764d': `Gå til side`, 's281846ef0421c71f': `November`, 's2c8189544e3ea679': `Prøv igen`, 's2ceb11be2290bb1b': `Annuller`, 's307db9af9905317d': `Formularfejloversigt`, 's31fc8b3aecbb26e8': `sorteret`, 's39938ecdae568740': `September`, 's39943b8a5733f5d2': `Automatisk afvisningstimer`, 's3b8a6245b12fa2ad': `Brødkrummer`, 's3d195621e562d805': `Vælg række`, 's407a88a592a0987c': `August`, 's49730f3d5751a433': `Indlæser...`, 's5052d10b539eabf0': `Marts`, 's5068a6876795d628': `Vælg synlige kolonner`, 's5d929ff1619ac0c9': `Søg`, 's5e8250fb85d64c23': `Luk`, 's5f4586bc1e2740e6': `Ryd søgning`, 's5febcd9b311c16fe': `Rul til højre`, 's626a661dd5858d8f': `Prøv at indlæse data igen`, 's63d040e37887f17e': `I dag`, 's6a89bb10338369b4': `Gå til forrige side`, 's6badfcac7ad931f1': `sorterbar`, 's6cfed919e21ac6ac': `Tor`, 's6d24cd19e23b8185': `Ti`, 's7350bb367d5e09ab': `Gå til sidste side`, 's74aa0319e62b2eb7': `Ons`, 's7793b811d20184fe': `December`, 's78e1e4c3066c51c1': `Ryd søgning for`, 's7edad99c6b7bfe88': `Gå til næste side`, 's7fd3469f78111589': `Åbn kontekstmenu`, 's83c436ed1bc16dfb': `Vis flere oplysninger`, 's84d3dbcd121dd01b': `faldende`, 's88365264d8a05b05': `Skift til næste måned`, 's8ade4e9d5e804d6a': `Første tilgængelige dato`, 's8af61807443f32a4': `Handlinger`, 's8af6c50191c92781': `Gå til første side`, 's8e68b824b99140a1': `stigende`, 's8f18916860db5d80': `Ryd valg`, 's9094c0cde8fb5058': `Ingen resultater fundet`, 's909e876731a8febb': `Vælg alle rækker`, 's90a641043aa30c1e': `Rækker pr. side`, 's979f38023babd06d': `Afvis advarsel`, 's9836b719fa8ef857': `Lør`, 's987ac119fac8d621': `Søn`, 's98dfb7a8cd8ec342': `Vælg dagens dato`, 'sa26d7a273074cbf9': `Ingen data tilgængelige`, 'sa3a7061ff10a8138': `rækker`, 'sa6f2645578b2d2bc': `År`, 'sa7cd5c2ff6d266e7': `Oktober`, 'sb0f3327210fe18fc': `Kolonner`, 'sb47daaf9e1c4a905': `Måned`, 'sb4f1dffbb6be6302': `Ryd`, 'sbbea6041f19ec177': `Fejl ved indlæsning af data`, 'sbc083a1dbee9af73': `Februar`, 'sc9ba1c07c319d0ab': `Datatabul med`, 'scab955958b9b783e': str`Der er fejl, der skal rettes, før du kan fortsætte`, 'scb6b9cb49cf93277': `April`, 'scfe20e6b9fcd18ad': `Søg i tabel`, 'sd186574aa8a68ecb': `Ingen resultater for`, 'sd898d99fd9c13de6': `Filtrer tilgængelige muligheder`, 'sdc42f1da42d6411a': `Ryd inputfelt`, 'se0955919920ee87d': `Dag`, 'se4129fd6b9d7b4c2': `Sidste tilgængelige dato`, 'se682f076f6506f9b': `Gå til side`, 'sf1f100572e888a9d': `Skift til forrige måned`, 'sf295af199c723ec8': `Fre`, }" } ], "exports": [ { "kind": "js", "name": "templates", "declaration": { "name": "templates", "module": "src/generated/locales/da.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/locales/de.ts", "declarations": [ { "kind": "variable", "name": "templates", "type": { "text": "object" }, "default": "{ 's023f114f575b5bd5': `Aktuelle Seite`, 's038b2a0deba58916': `Seite`, 's03c44f5a1b0581d4': `ausgewählt`, 's08b06007b5567108': `von`, 's09023907b59c38eb': `Gehen`, 's15a16ae9f99f19bf': `Juli`, 's15a852e9f9a50fa5': `Juni`, 's1727e353c65eba61': `Ausgewähltes Datum löschen`, 's17e3edbe032f79ec': `Kalender-Modal öffnen`, 's1910f3ebccaec414': str`${0} ausgewählt`, 's1a2dda8f763a68bd': `Januar`, 's1e118319b5202c41': `Mo`, 's1e187019b5262aa6': `Mai`, 's22237cd4f966764d': `Zur Seite springen`, 's281846ef0421c71f': `November`, 's2c8189544e3ea679': `Erneut versuchen`, 's2ceb11be2290bb1b': `Abbrechen`, 's307db9af9905317d': `Formularfehlerübersicht`, 's31fc8b3aecbb26e8': `sortiert`, 's39938ecdae568740': `September`, 's39943b8a5733f5d2': `Automatischer Schließ-Timer`, 's3b8a6245b12fa2ad': `Brotkrümelnavigation`, 's3d195621e562d805': `Zeile auswählen`, 's407a88a592a0987c': `August`, 's49730f3d5751a433': `Laden...`, 's5052d10b539eabf0': `März`, 's5068a6876795d628': `Sichtbare Spalten auswählen`, 's5d929ff1619ac0c9': `Suche`, 's5e8250fb85d64c23': `Schließen`, 's5f4586bc1e2740e6': `Suche löschen`, 's5febcd9b311c16fe': `Nach rechts scrollen`, 's626a661dd5858d8f': `Versuch zu laden Daten erneut`, 's63d040e37887f17e': `Heute`, 's6a89bb10338369b4': `Zur vorherigen Seite gehen`, 's6badfcac7ad931f1': `sortierbar`, 's6cfed919e21ac6ac': `Do`, 's6d24cd19e23b8185': `Di`, 's7350bb367d5e09ab': `Zur letzten Seite gehen`, 's74aa0319e62b2eb7': `Mi`, 's7793b811d20184fe': `Dezember`, 's78e1e4c3066c51c1': `Suche löschen für`, 's7edad99c6b7bfe88': `Zur nächsten Seite gehen`, 's7fd3469f78111589': `Kontextmenü öffnen`, 's83c436ed1bc16dfb': `Weitere Informationen anzeigen`, 's84d3dbcd121dd01b': `absteigend`, 's88365264d8a05b05': `Zum nächsten Monat wechseln`, 's8ade4e9d5e804d6a': `Erstes verfügbares Datum`, 's8af61807443f32a4': `Aktionen`, 's8af6c50191c92781': `Zur ersten Seite gehen`, 's8e68b824b99140a1': `aufsteigend`, 's8f18916860db5d80': `Auswahl löschen`, 's9094c0cde8fb5058': `Keine Ergebnisse gefunden`, 's909e876731a8febb': `Alle Zeilen auswählen`, 's90a641043aa30c1e': `Zeilen pro Seite`, 's979f38023babd06d': `Benachrichtigung schließen`, 's9836b719fa8ef857': `Sa`, 's987ac119fac8d621': `So`, 's98dfb7a8cd8ec342': `Wählen Sie das heutige Datum`, 'sa26d7a273074cbf9': `Keine Daten verfügbar`, 'sa3a7061ff10a8138': `Zeilen`, 'sa6f2645578b2d2bc': `Jahr`, 'sa7cd5c2ff6d266e7': `Oktober`, 'sb0f3327210fe18fc': `Spalten`, 'sb47daaf9e1c4a905': `Monat`, 'sb4f1dffbb6be6302': `Löschen`, 'sbbea6041f19ec177': `Fehler beim Laden von Daten`, 'sbc083a1dbee9af73': `Februar`, 'sc9ba1c07c319d0ab': `Datentabelle mit`, 'scab955958b9b783e': str`Es gibt Fehler, die korrigiert werden müssen, bevor Sie fortfahren können`, 'scb6b9cb49cf93277': `April`, 'scfe20e6b9fcd18ad': `Tabelle durchsuchen`, 'sd186574aa8a68ecb': `Keine Ergebnisse für`, 'sd898d99fd9c13de6': `Verfügbare Optionen filtern`, 'sdc42f1da42d6411a': `Feld löschen`, 'se0955919920ee87d': `Tag`, 'se4129fd6b9d7b4c2': `Letztes verfügbares Datum`, 'se682f076f6506f9b': `Zur Seite gehen`, 'sf1f100572e888a9d': `Zum vorherigen Monat wechseln`, 'sf295af199c723ec8': `Fr`, }" } ], "exports": [ { "kind": "js", "name": "templates", "declaration": { "name": "templates", "module": "src/generated/locales/de.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/locales/fi.ts", "declarations": [ { "kind": "variable", "name": "templates", "type": { "text": "object" }, "default": "{ 's023f114f575b5bd5': `Nykyinen sivu`, 's038b2a0deba58916': `sivu`, 's03c44f5a1b0581d4': `valittu`, 's08b06007b5567108': `/ `, 's09023907b59c38eb': `Siirry`, 's15a16ae9f99f19bf': `Heinä`, 's15a852e9f9a50fa5': `Kesä`, 's1727e353c65eba61': `Tyhjennä valittu päivämäärä`, 's17e3edbe032f79ec': `Avaa kalenteri-modal`, 's1910f3ebccaec414': str`${0} valittu`, 's1a2dda8f763a68bd': `Tammikuu`, 's1e118319b5202c41': `Ma`, 's1e187019b5262aa6': `Touko`, 's22237cd4f966764d': `Siirry sivulle`, 's281846ef0421c71f': `Marraskuu`, 's2c8189544e3ea679': `Yritä uudelleen`, 's2ceb11be2290bb1b': `Peruuta`, 's307db9af9905317d': `Lomakkeen virheiden yhteenveto`, 's31fc8b3aecbb26e8': `lajiteltu`, 's39938ecdae568740': `Syys`, 's39943b8a5733f5d2': `Automaattinen sulkeutumisaika`, 's3b8a6245b12fa2ad': `Murupolku`, 's3d195621e562d805': `Valitse rivi`, 's407a88a592a0987c': `Elokuu`, 's49730f3d5751a433': `Ladataan...`, 's5052d10b539eabf0': `Maalis`, 's5068a6876795d628': `Valitse näkyvät sarakkeet`, 's5d929ff1619ac0c9': `Hae`, 's5e8250fb85d64c23': `Sulje`, 's5f4586bc1e2740e6': `Tyhjennä haku`, 's5febcd9b311c16fe': `Vieritä oikealle`, 's626a661dd5858d8f': `Yritä ladata tiedot uudelleen`, 's63d040e37887f17e': `Tänään`, 's6a89bb10338369b4': `Siirry edelliselle sivulle`, 's6badfcac7ad931f1': `lajiteltavissa`, 's6cfed919e21ac6ac': `To`, 's6d24cd19e23b8185': `Ti`, 's7350bb367d5e09ab': `Siirry viimeiselle sivulle`, 's74aa0319e62b2eb7': `Ke`, 's7793b811d20184fe': `Joulukuu`, 's78e1e4c3066c51c1': `Tyhjennä haku kohteelle`, 's7edad99c6b7bfe88': `Siirry seuraavalle sivulle`, 's7fd3469f78111589': `Avaa pikavalikko`, 's83c436ed1bc16dfb': `Näytä lisää tietoja`, 's84d3dbcd121dd01b': `laskeva`, 's88365264d8a05b05': `Vaihda seuraavaan kuukauteen`, 's8ade4e9d5e804d6a': `Ensimmäinen saatavilla oleva päivämäärä`, 's8af61807443f32a4': `Toiminnot`, 's8af6c50191c92781': `Siirry ensimmäiselle sivulle`, 's8e68b824b99140a1': `nouseva`, 's8f18916860db5d80': `Tyhjennä valinta`, 's9094c0cde8fb5058': `Tuloksia ei löytynyt`, 's909e876731a8febb': `Valitse kaikki rivit`, 's90a641043aa30c1e': `Rivit sivulla`, 's979f38023babd06d': `Ohita hälytys`, 's9836b719fa8ef857': `La`, 's987ac119fac8d621': `Su`, 's98dfb7a8cd8ec342': `Valitse tämän päivän päivämäärä`, 'sa26d7a273074cbf9': `Ei tietoja saatavilla`, 'sa3a7061ff10a8138': `rivit`, 'sa6f2645578b2d2bc': `Vuosi`, 'sa7cd5c2ff6d266e7': `Lokakuu`, 'sb0f3327210fe18fc': `Sarakkeet`, 'sb47daaf9e1c4a905': `Kuukausi`, 'sb4f1dffbb6be6302': `Tyhjennä`, 'sbbea6041f19ec177': `Virhe tietojen lataamisessa`, 'sbc083a1dbee9af73': `Helmikuu`, 'sc9ba1c07c319d0ab': `Tietojen taulukko, jossa on`, 'scab955958b9b783e': str`Korjattavia virheitä ennen kuin voit jatkaa`, 'scb6b9cb49cf93277': `Huhti`, 'scfe20e6b9fcd18ad': `Etsi taulukosta`, 'sd186574aa8a68ecb': `Ei tuloksia kohteelle`, 'sd898d99fd9c13de6': `Suodata saatavilla olevia vaihtoehtoja`, 'sdc42f1da42d6411a': `Tyhjennä syöte`, 'se0955919920ee87d': `Päivä`, 'se4129fd6b9d7b4c2': `Viimeinen saatavilla oleva päivämäärä`, 'se682f076f6506f9b': `Siirry sivulle`, 'sf1f100572e888a9d': `Vaihda edelliseen kuukauteen`, 'sf295af199c723ec8': `Pe`, }" } ], "exports": [ { "kind": "js", "name": "templates", "declaration": { "name": "templates", "module": "src/generated/locales/fi.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/locales/fr.ts", "declarations": [ { "kind": "variable", "name": "templates", "type": { "text": "object" }, "default": "{ 's023f114f575b5bd5': `Page actuelle`, 's038b2a0deba58916': `page`, 's03c44f5a1b0581d4': `sélectionné`, 's08b06007b5567108': `sur`, 's09023907b59c38eb': `Aller`, 's15a16ae9f99f19bf': `Juillet`, 's15a852e9f9a50fa5': `Juin`, 's1727e353c65eba61': `Effacer la date sélectionnée`, 's17e3edbe032f79ec': `Ouvrir le calendrier modal`, 's1910f3ebccaec414': str`${0} options sélectionnés`, 's1a2dda8f763a68bd': `Janvier`, 's1e118319b5202c41': `Lun`, 's1e187019b5262aa6': `Mai`, 's22237cd4f966764d': `Accéder à la page`, 's281846ef0421c71f': `Novembre`, 's2c8189544e3ea679': `Réessayer`, 's2ceb11be2290bb1b': `Annuler`, 's307db9af9905317d': `Résumé des erreurs du formulaire`, 's31fc8b3aecbb26e8': `trié`, 's39938ecdae568740': `Septembre`, 's39943b8a5733f5d2': `Minuterie de fermeture automatique`, 's3b8a6245b12fa2ad': `Fil d'Ariane`, 's3d195621e562d805': `Sélectionner la ligne`, 's407a88a592a0987c': `Août`, 's49730f3d5751a433': `Chargement...`, 's5052d10b539eabf0': `Mars`, 's5068a6876795d628': `Sélectionner les colonnes visibles`, 's5d929ff1619ac0c9': `Rechercher`, 's5e8250fb85d64c23': `Fermer`, 's5f4586bc1e2740e6': `Effacer la recherche`, 's5febcd9b311c16fe': `Faire défiler à droite`, 's626a661dd5858d8f': `Réessayer de charger les données`, 's63d040e37887f17e': `Aujourd'hui`, 's6a89bb10338369b4': `Aller à la page précédente`, 's6badfcac7ad931f1': `triable`, 's6cfed919e21ac6ac': `Jeu`, 's6d24cd19e23b8185': `Mar`, 's7350bb367d5e09ab': `Aller à la dernière page`, 's74aa0319e62b2eb7': `Mer`, 's7793b811d20184fe': `Décembre`, 's78e1e4c3066c51c1': `Effacer la recherche pour`, 's7edad99c6b7bfe88': `Aller à la page suivante`, 's7fd3469f78111589': `Ouvrir le menu contextuel`, 's83c436ed1bc16dfb': `Afficher plus d'informations`, 's84d3dbcd121dd01b': `descendant`, 's88365264d8a05b05': `Passer au mois suivant`, 's8ade4e9d5e804d6a': `Première date disponible`, 's8af61807443f32a4': `Actions`, 's8af6c50191c92781': `Aller à la première page`, 's8e68b824b99140a1': `ascendant`, 's8f18916860db5d80': `Effacer la sélection`, 's9094c0cde8fb5058': `Aucun résultat trouvé`, 's909e876731a8febb': `Sélectionner toutes les lignes`, 's90a641043aa30c1e': `Lignes par page`, 's979f38023babd06d': `Fermer l'alerte`, 's9836b719fa8ef857': `Sam`, 's987ac119fac8d621': `Dim`, 's98dfb7a8cd8ec342': `Sélectionnez la date du jour`, 'sa26d7a273074cbf9': `Aucune donnée disponible`, 'sa3a7061ff10a8138': `lignes`, 'sa6f2645578b2d2bc': `Année`, 'sa7cd5c2ff6d266e7': `Octobre`, 'sb0f3327210fe18fc': `Colonnes`, 'sb47daaf9e1c4a905': `Mois`, 'sb4f1dffbb6be6302': `Effacer`, 'sbbea6041f19ec177': `Erreur lors du chargement des données`, 'sbc083a1dbee9af73': `Février`, 'sc9ba1c07c319d0ab': `Tableau de données avec`, 'scab955958b9b783e': str`Il y a des erreurs à corriger avant de pouvoir continuer`, 'scb6b9cb49cf93277': `Avril`, 'scfe20e6b9fcd18ad': `Rechercher dans le tableau`, 'sd186574aa8a68ecb': `Aucun résultat pour`, 'sd898d99fd9c13de6': `Filtrer les options disponibles`, 'sdc42f1da42d6411a': `Effacer la saisie`, 'se0955919920ee87d': `Jour`, 'se4129fd6b9d7b4c2': `Dernière date disponible`, 'se682f076f6506f9b': `Aller à la page`, 'sf1f100572e888a9d': `Passer au mois précédent`, 'sf295af199c723ec8': `Ven`, }" } ], "exports": [ { "kind": "js", "name": "templates", "declaration": { "name": "templates", "module": "src/generated/locales/fr.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/locales/it.ts", "declarations": [ { "kind": "variable", "name": "templates", "type": { "text": "object" }, "default": "{ 's023f114f575b5bd5': `Pagina corrente`, 's038b2a0deba58916': `pagina`, 's03c44f5a1b0581d4': `selezionato`, 's08b06007b5567108': `di`, 's09023907b59c38eb': `Vai`, 's15a16ae9f99f19bf': `Luglio`, 's15a852e9f9a50fa5': `Giugno`, 's1727e353c65eba61': `Pulisci la data selezionata`, 's17e3edbe032f79ec': `Apri la finestra del calendario`, 's1910f3ebccaec414': str`${0} opzioni selezionate`, 's1a2dda8f763a68bd': `Gennaio`, 's1e118319b5202c41': `Lun`, 's1e187019b5262aa6': `Maggio`, 's22237cd4f966764d': `Vai a pagina`, 's281846ef0421c71f': `Novembre`, 's2c8189544e3ea679': `Riprova`, 's2ceb11be2290bb1b': `Annulla`, 's307db9af9905317d': `Riepilogo degli errori del modulo`, 's31fc8b3aecbb26e8': `ordinato`, 's39938ecdae568740': `Settembre`, 's39943b8a5733f5d2': `Timer di chiusura automatica`, 's3b8a6245b12fa2ad': `Percorso di navigazione`, 's3d195621e562d805': `Seleziona riga`, 's407a88a592a0987c': `Agosto`, 's49730f3d5751a433': `Caricamento...`, 's5052d10b539eabf0': `Marzo`, 's5068a6876795d628': `Seleziona colonne visibili`, 's5d929ff1619ac0c9': `Cerca`, 's5e8250fb85d64c23': `Chiudi`, 's5f4586bc1e2740e6': `Cancella ricerca`, 's5febcd9b311c16fe': `Scorri a destra`, 's626a661dd5858d8f': `Riprova a caricare i dati`, 's63d040e37887f17e': `Oggi`, 's6a89bb10338369b4': `Vai alla pagina precedente`, 's6badfcac7ad931f1': `ordinabile`, 's6cfed919e21ac6ac': `Gio`, 's6d24cd19e23b8185': `Mar`, 's7350bb367d5e09ab': `Vai all'ultima pagina`, 's74aa0319e62b2eb7': `Mer`, 's7793b811d20184fe': `Dicembre`, 's78e1e4c3066c51c1': `Cancella la ricerca per`, 's7edad99c6b7bfe88': `Vai alla pagina successiva`, 's7fd3469f78111589': `Apri il menu contestuale`, 's83c436ed1bc16dfb': `Mostra più informazioni`, 's84d3dbcd121dd01b': `discendente`, 's88365264d8a05b05': `Passa al mese successivo`, 's8ade4e9d5e804d6a': `Prima data disponibile`, 's8af61807443f32a4': `Azioni`, 's8af6c50191c92781': `Vai alla prima pagina`, 's8e68b824b99140a1': `ascendente`, 's8f18916860db5d80': `Rimuovi selezione`, 's9094c0cde8fb5058': `Nessun risultato trovato`, 's909e876731a8febb': `Seleziona tutte le righe`, 's90a641043aa30c1e': `Righe per pagina`, 's979f38023babd06d': `Chiudi avviso`, 's9836b719fa8ef857': `Sab`, 's987ac119fac8d621': `Dom`, 's98dfb7a8cd8ec342': `Seleziona la data odierna`, 'sa26d7a273074cbf9': `Nessun dato disponibile`, 'sa3a7061ff10a8138': `righe`, 'sa6f2645578b2d2bc': `Anno`, 'sa7cd5c2ff6d266e7': `Ottobre`, 'sb0f3327210fe18fc': `Colonne`, 'sb47daaf9e1c4a905': `Mese`, 'sb4f1dffbb6be6302': `Pulisci`, 'sbbea6041f19ec177': `Errore nel caricamento dei dati`, 'sbc083a1dbee9af73': `Febbraio`, 'sc9ba1c07c319d0ab': `Tabella dati con`, 'scab955958b9b783e': str`Ci sono errori da correggere prima di poter continuare`, 'scb6b9cb49cf93277': `Aprile`, 'scfe20e6b9fcd18ad': `Cerca nella tabella`, 'sd186574aa8a68ecb': `Nessun risultato per`, 'sd898d99fd9c13de6': `Filtra le opzioni disponibili`, 'sdc42f1da42d6411a': `Pulisci il campo di input`, 'se0955919920ee87d': `Giorno`, 'se4129fd6b9d7b4c2': `Ultima data disponibile`, 'se682f076f6506f9b': `Vai a pagina`, 'sf1f100572e888a9d': `Passa al mese precedente`, 'sf295af199c723ec8': `Ven`, }" } ], "exports": [ { "kind": "js", "name": "templates", "declaration": { "name": "templates", "module": "src/generated/locales/it.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/locales/nl.ts", "declarations": [ { "kind": "variable", "name": "templates", "type": { "text": "object" }, "default": "{ 's023f114f575b5bd5': `Huidige pagina`, 's038b2a0deba58916': `pagina`, 's03c44f5a1b0581d4': `geselecteerd`, 's08b06007b5567108': `van`, 's09023907b59c38eb': `Gaan`, 's15a16ae9f99f19bf': `Juli`, 's15a852e9f9a50fa5': `Juni`, 's1727e353c65eba61': `Wis geselecteerde datum`, 's17e3edbe032f79ec': `Open kalenderpop-up`, 's1910f3ebccaec414': str`${0} geselecteerd`, 's1a2dda8f763a68bd': `Januari`, 's1e118319b5202c41': `Ma`, 's1e187019b5262aa6': `Mei`, 's22237cd4f966764d': `Ga naar pagina`, 's281846ef0421c71f': `November`, 's2c8189544e3ea679': `Opnieuw proberen`, 's2ceb11be2290bb1b': `Annuleren`, 's307db9af9905317d': `Formulierfoutoverzicht`, 's31fc8b3aecbb26e8': `gesorteerd`, 's39938ecdae568740': `September`, 's39943b8a5733f5d2': `Automatisch sluiten timer`, 's3b8a6245b12fa2ad': `Kruimelpad`, 's3d195621e562d805': `Selecteer rij`, 's407a88a592a0987c': `Augustus`, 's49730f3d5751a433': `Laden...`, 's5052d10b539eabf0': `Maart`, 's5068a6876795d628': `Selecteer zichtbare kolommen`, 's5d929ff1619ac0c9': `Zoeken`, 's5e8250fb85d64c23': `Sluiten`, 's5f4586bc1e2740e6': `Zoekopdracht wissen`, 's5febcd9b311c16fe': `Scroll rechts`, 's626a661dd5858d8f': `Probeer gegevens opnieuw in te laden`, 's63d040e37887f17e': `Vandaag`, 's6a89bb10338369b4': `Ga naar vorige pagina`, 's6badfcac7ad931f1': `sorteerbaar`, 's6cfed919e21ac6ac': `Do`, 's6d24cd19e23b8185': `Di`, 's7350bb367d5e09ab': `Ga naar laatste pagina`, 's74aa0319e62b2eb7': `Wo`, 's7793b811d20184fe': `December`, 's78e1e4c3066c51c1': `Zoekopdracht voor wissen`, 's7edad99c6b7bfe88': `Ga naar volgende pagina`, 's7fd3469f78111589': `Open contextmenu`, 's83c436ed1bc16dfb': `Toon meer informatie`, 's84d3dbcd121dd01b': `aflopend`, 's88365264d8a05b05': `Schakel naar volgende maand`, 's8ade4e9d5e804d6a': `Eerste beschikbare datum`, 's8af61807443f32a4': `Acties`, 's8af6c50191c92781': `Ga naar eerste pagina`, 's8e68b824b99140a1': `oplopend`, 's8f18916860db5d80': `Wis selectie`, 's9094c0cde8fb5058': `Geen resultaten gevonden`, 's909e876731a8febb': `Selecteer alle rijen`, 's90a641043aa30c1e': `Rijen per pagina`, 's979f38023babd06d': `Waarschuwing sluiten`, 's9836b719fa8ef857': `Za`, 's987ac119fac8d621': `Zo`, 's98dfb7a8cd8ec342': `Selecteer de datum van vandaag`, 'sa26d7a273074cbf9': `Geen gegevens beschikbaar`, 'sa3a7061ff10a8138': `rijen`, 'sa6f2645578b2d2bc': `Jaar`, 'sa7cd5c2ff6d266e7': `Oktober`, 'sb0f3327210fe18fc': `Kolommen`, 'sb47daaf9e1c4a905': `Maand`, 'sb4f1dffbb6be6302': `Wis`, 'sbbea6041f19ec177': `Fout bij het laden van gegevens`, 'sbc083a1dbee9af73': `Februari`, 'sc9ba1c07c319d0ab': `Gegevenstabel met`, 'scab955958b9b783e': str`Er zijn fouten die gecorrigeerd moeten worden voordat u kunt doorgaan`, 'scb6b9cb49cf93277': `April`, 'scfe20e6b9fcd18ad': `Zoek tabel`, 'sd186574aa8a68ecb': `Geen resultaten voor`, 'sd898d99fd9c13de6': `Filter beschikbare opties`, 'sdc42f1da42d6411a': `Wis invoer`, 'se0955919920ee87d': `Dag`, 'se4129fd6b9d7b4c2': `Laatste beschikbare datum`, 'se682f076f6506f9b': `Ga naar pagina`, 'sf1f100572e888a9d': `Schakel naar vorige maand`, 'sf295af199c723ec8': `Vr`, }" } ], "exports": [ { "kind": "js", "name": "templates", "declaration": { "name": "templates", "module": "src/generated/locales/nl.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/locales/no.ts", "declarations": [ { "kind": "variable", "name": "templates", "type": { "text": "object" }, "default": "{ 's023f114f575b5bd5': `Gjeldende side`, 's038b2a0deba58916': `side`, 's03c44f5a1b0581d4': `valgt`, 's08b06007b5567108': `av`, 's09023907b59c38eb': `Gå`, 's15a16ae9f99f19bf': `Juli`, 's15a852e9f9a50fa5': `Juni`, 's1727e353c65eba61': `Rens valgt dato`, 's17e3edbe032f79ec': `Åpne kalendermodal`, 's1910f3ebccaec414': str`${0} alternativer valgt`, 's1a2dda8f763a68bd': `Januar`, 's1e118319b5202c41': `Man`, 's1e187019b5262aa6': `Mai`, 's22237cd4f966764d': `Gå til side`, 's281846ef0421c71f': `November`, 's2c8189544e3ea679': `Prøv igjen`, 's2ceb11be2290bb1b': `Avbryt`, 's307db9af9905317d': `Skjema feil oppsummering`, 's31fc8b3aecbb26e8': `sortert`, 's39938ecdae568740': `September`, 's39943b8a5733f5d2': `Automatisk lukk-timer`, 's3b8a6245b12fa2ad': `Brødsmuler`, 's3d195621e562d805': `Velg rad`, 's407a88a592a0987c': `August`, 's49730f3d5751a433': `Laster...`, 's5052d10b539eabf0': `Mars`, 's5068a6876795d628': `Velg synlige kolonner`, 's5d929ff1619ac0c9': `Søk`, 's5e8250fb85d64c23': `Lukk`, 's5f4586bc1e2740e6': `Fjern søk`, 's5febcd9b311c16fe': `Rull til høyre`, 's626a661dd5858d8f': `Prøv å laste data på nytt`, 's63d040e37887f17e': `I dag`, 's6a89bb10338369b4': `Gå til forrige side`, 's6badfcac7ad931f1': `sorterbar`, 's6cfed919e21ac6ac': `Tor`, 's6d24cd19e23b8185': `Tir`, 's7350bb367d5e09ab': `Gå til siste side`, 's74aa0319e62b2eb7': `Ons`, 's7793b811d20184fe': `Desember`, 's78e1e4c3066c51c1': `Fjern søk for`, 's7edad99c6b7bfe88': `Gå til neste side`, 's7fd3469f78111589': `Åpne kontekstmeny`, 's83c436ed1bc16dfb': `Vis mer informasjon`, 's84d3dbcd121dd01b': `synkende`, 's88365264d8a05b05': `Bytt til neste måned`, 's8ade4e9d5e804d6a': `Første tilgjengelige dato`, 's8af61807443f32a4': `Handlinger`, 's8af6c50191c92781': `Gå til første side`, 's8e68b824b99140a1': `stigende`, 's8f18916860db5d80': `Ryd valg`, 's9094c0cde8fb5058': `Ingen resultater funnet`, 's909e876731a8febb': `Velg alle rader`, 's90a641043aa30c1e': `Rader per side`, 's979f38023babd06d': `Lukk varsel`, 's9836b719fa8ef857': `Lør`, 's987ac119fac8d621': `Søn`, 's98dfb7a8cd8ec342': `Velg dagens dato`, 'sa26d7a273074cbf9': `Ingen data tilgjengelig`, 'sa3a7061ff10a8138': `rader`, 'sa6f2645578b2d2bc': `År`, 'sa7cd5c2ff6d266e7': `Oktober`, 'sb0f3327210fe18fc': `Kolonner`, 'sb47daaf9e1c4a905': `Måned`, 'sb4f1dffbb6be6302': `Rens`, 'sbbea6041f19ec177': `Feil ved lasting av data`, 'sbc083a1dbee9af73': `Februar`, 'sc9ba1c07c319d0ab': `Datatabell med`, 'scab955958b9b783e': str`Det er feil som må rettes før du kan fortsette`, 'scb6b9cb49cf93277': `April`, 'scfe20e6b9fcd18ad': `Søk i tabell`, 'sd186574aa8a68ecb': `Ingen resultater for`, 'sd898d99fd9c13de6': `Filtrer tilgjengelige alternativer`, 'sdc42f1da42d6411a': `Rens inputfelt`, 'se0955919920ee87d': `Dag`, 'se4129fd6b9d7b4c2': `Siste tilgjengelige dato`, 'se682f076f6506f9b': `Gå til side`, 'sf1f100572e888a9d': `Bytt til forrige måned`, 'sf295af199c723ec8': `Fre`, }" } ], "exports": [ { "kind": "js", "name": "templates", "declaration": { "name": "templates", "module": "src/generated/locales/no.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/locales/sv.ts", "declarations": [ { "kind": "variable", "name": "templates", "type": { "text": "object" }, "default": "{ 's023f114f575b5bd5': `Nuvarande sida`, 's038b2a0deba58916': `sida`, 's03c44f5a1b0581d4': `vald`, 's08b06007b5567108': `av`, 's09023907b59c38eb': `Gå`, 's15a16ae9f99f19bf': `Juli`, 's15a852e9f9a50fa5': `Juni`, 's1727e353c65eba61': `Rensa valt datum`, 's17e3edbe032f79ec': `Öppna kalender`, 's1910f3ebccaec414': str`${0} valda alternativ`, 's1a2dda8f763a68bd': `Januari`, 's1e118319b5202c41': `Mån`, 's1e187019b5262aa6': `Maj`, 's22237cd4f966764d': `Gå till sida`, 's281846ef0421c71f': `November`, 's2c8189544e3ea679': `Försök igen`, 's2ceb11be2290bb1b': `Avbryt`, 's307db9af9905317d': `Sammanfattning av formulärfel`, 's31fc8b3aecbb26e8': `sorterad`, 's39938ecdae568740': `September`, 's39943b8a5733f5d2': `Automatisk stängningstimer`, 's3b8a6245b12fa2ad': `Brödsmulor`, 's3d195621e562d805': `Välj rad`, 's407a88a592a0987c': `Augusti`, 's49730f3d5751a433': `Laddar...`, 's5052d10b539eabf0': `Mars`, 's5068a6876795d628': `Välj synliga kolumner`, 's5d929ff1619ac0c9': `Sök`, 's5e8250fb85d64c23': `Stäng`, 's5f4586bc1e2740e6': `Rensa sökning`, 's5febcd9b311c16fe': `Scrolla höger`, 's626a661dd5858d8f': `Försök att ladda data igen`, 's63d040e37887f17e': `Idag`, 's6a89bb10338369b4': `Gå till föregående sida`, 's6badfcac7ad931f1': `sorterbar`, 's6cfed919e21ac6ac': `Tor`, 's6d24cd19e23b8185': `Tis`, 's7350bb367d5e09ab': `Gå till sista sidan`, 's74aa0319e62b2eb7': `Ons`, 's7793b811d20184fe': `December`, 's78e1e4c3066c51c1': `Rensa sökning för`, 's7edad99c6b7bfe88': `Gå till nästa sida`, 's7fd3469f78111589': `Öppna meny`, 's83c436ed1bc16dfb': `Visa mer information`, 's84d3dbcd121dd01b': `fallande`, 's88365264d8a05b05': `Växla till nästa månad`, 's8ade4e9d5e804d6a': `Första tillgängliga datum`, 's8af61807443f32a4': `Åtgärder`, 's8af6c50191c92781': `Gå till första sidan`, 's8e68b824b99140a1': `stigande`, 's8f18916860db5d80': `Rensa val`, 's9094c0cde8fb5058': `Inga resultat hittades`, 's909e876731a8febb': `Välj alla rader`, 's90a641043aa30c1e': `Rader per sida`, 's979f38023babd06d': `Stäng varning`, 's9836b719fa8ef857': `Lör`, 's987ac119fac8d621': `Sön`, 's98dfb7a8cd8ec342': `Välj dagens datum`, 'sa26d7a273074cbf9': `Inga data tillgängliga`, 'sa3a7061ff10a8138': `rader`, 'sa6f2645578b2d2bc': `År`, 'sa7cd5c2ff6d266e7': `Oktober`, 'sb0f3327210fe18fc': `Kolumner`, 'sb47daaf9e1c4a905': `Månad`, 'sb4f1dffbb6be6302': `Rensa`, 'sbbea6041f19ec177': `Fel vid inladdning av data`, 'sbc083a1dbee9af73': `Februari`, 'sc9ba1c07c319d0ab': `Datatabell med`, 'scab955958b9b783e': str`Det finns fel att rätta innan du kan fortsätta`, 'scb6b9cb49cf93277': `April`, 'scfe20e6b9fcd18ad': `Söktabell`, 'sd186574aa8a68ecb': `Inga resultat för`, 'sd898d99fd9c13de6': `Sök i listan av val`, 'sdc42f1da42d6411a': `Rensa text`, 'se0955919920ee87d': `Dag`, 'se4129fd6b9d7b4c2': `Sista tillgängliga datum`, 'se682f076f6506f9b': `Gå till sida`, 'sf1f100572e888a9d': `Växla till föregående månad`, 'sf295af199c723ec8': `Fre`, }" } ], "exports": [ { "kind": "js", "name": "templates", "declaration": { "name": "templates", "module": "src/generated/locales/sv.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/field-base/field-base.component.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/primitives/field-base/field-base.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, a11y; @layer a11y { @media (prefers-reduced-motion: reduce) { .field { transition: none; } } } @layer base { * { box-sizing: border-box; } .field { display: flex; position: relative; align-items: center; justify-content: space-between; gap: var(--gds-sys-space-xs); padding-block: var(--gds-sys-space-xs); padding-inline: var(--gds-sys-space-m) var(--gds-sys-space-s); min-block-size: var(--gds-sys-space-3xl); block-size: var(--gds-sys-space-3xl); outline-style: solid; outline-width: 0; border-radius: var(--gds-sys-radius-xs); background: var(--gds-sys-color-l3-neutral-02); color: var(--gds-sys-color-content-neutral-01); outline-offset: 0; border: var(--gds-sys-space-5xs) solid var(--gds-sys-color-border-neutral-01); cursor: text; transition-property: background-color, outline-offset; backface-visibility: hidden; transition-duration: var(--gds-sys-motion-duration-fastest); transition-timing-function: var(--gds-sys-motion-easing-linear); .right { display: contents; } .right.as-flex { display: flex; position: absolute; gap: var(--gds-sys-space-xs); right: var(--gds-sys-space-xs); top: var(--gds-sys-space-xs); block-size: max-content; } } .field:focus-within { outline-width: var(--gds-sys-space-4xs); outline-offset: var(--gds-sys-space-4xs); outline-color: currentColor; border-color: currentColor; } .field.small { gap: var(--gds-sys-space-3xs); padding: var(--gds-sys-space-3xs) var(--gds-sys-space-xs); min-block-size: var(--gds-sys-space-2xl); block-size: var(--gds-sys-space-2xl); border-radius: var(--gds-sys-radius-2xs); } .field.multiline { align-items: flex-start; padding: var(--gds-sys-space-s); padding-inline-start: var(--gds-sys-space-m); height: max-content; } .field.disabled { background: var(--gds-sys-color-l3-disabled-01); color: var(--gds-sys-color-content-disabled-01); border-color: transparent; pointer-events: none; } .field.invalid { background: var(--gds-sys-color-l3-negative-02); border-color: var(--gds-sys-color-border-negative-01); color: var(--gds-sys-color-content-negative-01); } .field.lead-slot-occupied { padding-inline-start: var(--gds-sys-space-s); } .field.lead-has-badge { padding-inline-start: var(--gds-sys-space-2xs); } .field.small.lead-has-badge { padding-inline-start: var(--gds-sys-space-2xs); } .field.trail-slot-occupied { padding-inline-end: var(--gds-sys-space-xs); } .field.small.trail-slot-occupied { padding-inline-end: var(--gds-sys-space-2xs); } .field.action-slot-occupied:not(.trail-slot-occupied) { padding-inline-end: var(--gds-sys-space-s); } .field.small.action-slot-occupied:not(.trail-slot-occupied) { padding-inline-end: var(--gds-sys-space-2xs); } slot:not([name])::slotted(*) { color: currentColor; } .main-slot-wrap { display: flex; gap: var(--gds-sys-space-xs); flex: 1; align-self: stretch; } .main-slot-wrap.multiline { height: max-content; } @media (hover: hover) { .field:hover { background: color-mix( in srgb, var(--gds-sys-color-l3-neutral-02), var(--gds-sys-color-state-neutral-03) ); } .field.invalid:hover { background: color-mix( in srgb, var(--gds-sys-color-l3-negative-02), var(--gds-sys-color-state-negative-hover) ); } } slot[name='lead']::slotted([gds-element^='gds-icon-']) { align-items: center; justify-content: center; display: flex; inline-size: var(--gds-sys-space-l); block-size: var(--gds-sys-space-l); } .multiline slot[name='action']::slotted([gds-element]) { margin-top: -4px; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/primitives/field-base/field-base.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/field-base/field-base.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/primitives/field-base/field-base.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/primitives/field-base/field-base.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/field-base/field-base.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFieldBase", "declaration": { "name": "GdsFieldBase", "module": "src/primitives/field-base/field-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/field-base/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/field-base/field-base" } } ] }, { "kind": "javascript-module", "path": "src/primitives/form-control-footer/form-control-footer.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsFormControlFooter", "members": [ { "kind": "field", "name": "charCounter", "type": { "text": "[number, GdsBadge['variant'] | boolean] | undefined" }, "attribute": "charCounter" }, { "kind": "field", "name": "errorMessage", "type": { "text": "string | undefined" }, "attribute": "errorMessage" }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "charCounter", "type": { "text": "[number, GdsBadge['variant'] | boolean] | undefined" }, "fieldName": "charCounter" }, { "name": "errorMessage", "type": { "text": "string | undefined" }, "fieldName": "errorMessage" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-form-control-footer", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFormControlFooter", "declaration": { "name": "GdsFormControlFooter", "module": "src/primitives/form-control-footer/form-control-footer.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/form-control-footer/form-control-footer.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset, transitional-styles; @layer base { :host(.visually-hidden) { position: absolute; clip: rect(0 0 0 0); width: 0px; height: 0px; overflow: hidden; } :host > *:not(style) { display: flex; justify-content: space-between; align-items: center; gap: var(--gds-sys-space-xl); } .error-message { display: flex; align-items: flex-start; gap: var(--gds-sys-space-xs); margin-top: var(--gds-sys-space-3xs); font: var(--gds-sys-text-detail-s-regular); color: var(--gds-sys-color-content-negative-01); } [gds-element^='gds-icon'] { width: 18px; height: 18px; } :host(.size-small) { & .error-message { font: var(--gds-sys-text-detail-xs); gap: var(--gds-sys-space-3xs); } & [gds-element^='gds-icon'] { width: 16px; height: 16px; line-height: 16px; margin-right: 2px; } } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/primitives/form-control-footer/form-control-footer.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/form-control-footer/form-control-footer.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFormControlFooter", "declaration": { "name": "GdsFormControlFooter", "module": "src/primitives/form-control-footer/form-control-footer.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/form-control-footer/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/form-control-footer/form-control-footer" } } ] }, { "kind": "javascript-module", "path": "src/primitives/form-control-header/form-control-header.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsFormControlHeader", "slots": [ { "description": "The label of the form control.", "name": "label" }, { "description": "The supporting text of the form control.", "name": "supporting-text" }, { "description": "The extended supporting text, or \"Show more info\" card, of the form control.", "name": "extended-supporting-text" } ], "members": [ { "kind": "field", "name": "showExtendedSupportingText", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "attribute": "showExtendedSupportingText", "reflects": true }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "showExtendedSupportingText", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "fieldName": "showExtendedSupportingText" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-form-control-header", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFormControlHeader", "declaration": { "name": "GdsFormControlHeader", "module": "src/primitives/form-control-header/form-control-header.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/form-control-header/form-control-header.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset, transitional-styles; @layer base { #label-row { display: flex; justify-content: space-between; align-items: center; color: var(--gds-sys-color-content-neutral-01); } #label-row > div { display: flex; flex-direction: column; } slot[name='label']::slotted(*) { font: var(--_font-label, var(--gds-sys-text-detail-m-book)); } slot[name='supporting-text']::slotted(*) { font: var(--_font-supporting-text, var(--gds-sys-text-detail-s-regular)); } :host(.size-small) slot[name='supporting-text'], :host(.size-small) ::slotted(label) { font: var(--_font-label, var(--gds-sys-text-detail-s-book)); } #extended-supporting-text { opacity: 1; transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1); transition-duration: 368ms; transition-property: all; font: var(--_font-supporting-text, var(--gds-sys-text-detail-s-regular)); border-radius: var(--gds-sys-space-xs); background-color: var(--gds-sys-color-l3-neutral-02); color: var(--gds-sys-color-content-neutral-01); max-height: var(--_max-height); } #extended-supporting-text[aria-hidden='false'] { margin: var(--gds-sys-space-3xs) 0 0 0; padding: var(--gds-sys-space-s) var(--gds-sys-space-m); } #extended-supporting-text[aria-hidden='true'] { max-height: 0; opacity: 0; translate: 0 2px; padding: 0 var(--gds-sys-space-m); margin: 0; overflow: hidden; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/primitives/form-control-header/form-control-header.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/form-control-header/form-control-header.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFormControlHeader", "declaration": { "name": "GdsFormControlHeader", "module": "src/primitives/form-control-header/form-control-header.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/form-control-header/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/form-control-header/form-control-header" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/alert/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/badge/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/blur/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/breadcrumbs/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/button/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/calendar/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/card/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/card-linked/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/checkbox/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/coachmark/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/context-menu/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/datepicker/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/details/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/dialog/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/div/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/divider/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/dropdown/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/fab/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/filter-chips/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/flex/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/form-summary/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/grid/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/grouped-list/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/list-item/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/img/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/input/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/link/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/mask/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/menu-button/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/pagination/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/backdrop/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/popover/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/radio/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/rich-text/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/segmented-control/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/select/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/signal/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/spinner/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/table/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/text/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/textarea/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/theme/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/video/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/card-pattern-01/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/breadcrumb/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/checkbox-group/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-details/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/filter-chip/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/formatted-account/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/formatted-date/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/formatted-number/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/radio-group/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/segment/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/sensitive-account/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/sensitive-date/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/sensitive-number/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-ai/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-airplane-up/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-archive/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-bottom-top/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-box-left-alt/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-box-left/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-box-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-down/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-inbox/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-left-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-left/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-out-of-box/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-right-circle/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-right-down-circle/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-right-up-circle/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-rotate-clockwise/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-rotate-counter-clockwise/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-rotate-left-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-rotate-right-left/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-share-left/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-share-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-split/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-up/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-wall-down/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-wall-left/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-wall-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow-wall-up/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-arrow/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-asterisk/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-at/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-back/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-backward/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bag/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bank/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-banknote-2/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-banknote/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-barcode/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bars-three/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bars-two/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-basket/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-battery-loading/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bell/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-block/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-book/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bookmark-check/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bookmark-delete/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bookmark-plus/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bookmark-remove/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bookmark/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-books/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-app-store/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-apple-music/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-bankid/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-chrome/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-facebook/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-figma/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-firefox/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-github/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-green/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-instagram/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-linkedin/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-play-store/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-rss-feed/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-seb/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-spotify/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-storybook/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-swish-word/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brand-x/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-brush/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bubble-annotation/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bubbles/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-buildings/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-bullet-list/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-calculator/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-calendar-check/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-calendar/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-calender-add/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-call/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-car/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-carussel/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chain-link-broken/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chain-link/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chart-two/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-checklist/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-checkmark/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-bottom/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-double-down/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-double-left/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-double-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-double-up/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-down-small/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-grabber-vertical-reversed/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-grabber-vertical/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-left-small/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-left/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-right-small/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-top-small/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-chevron-top/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-circle-ban/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-circle-check/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-circle-dots/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-circle-info/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-circle-minus/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-circle-placeholder-on/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-circle-plus/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-circle-questionmark/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-circle-x/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-circles-three/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-clock/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-cloud-download/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-cloud-upload/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-cloudy-sun/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-code-brackets/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-code/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-compass-round/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-cookies/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-copy/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-credit-card-add/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-credit-card/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-cross-large/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-cross-small/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-cup-hot/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-cursor/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-devices/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-direction/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-dollar/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-dot-grid-one-horizontal/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-dot-grid-one-vertical/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-dot-grid-three/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-dot-grid-two/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-email/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-emoji-angry/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-emoji-neutral/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-emoji-sad/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-emoji-smile/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-emoji-smiley/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-euro/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-expand/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-eye-open/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-eye-slash/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-fashion/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-fast-forward/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-file-bend/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-file-chart/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-file-text/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-files/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-filter/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-flag/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-floppy-disk/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-focus/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-folder-add-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-folder/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-fullscreen/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-gift/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-globus/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-graduate-cap/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-green-power/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-group/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-growth/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-headphones/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-heart-beat/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-heart/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-history/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-home-energy-one/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-home-energy-two/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-home-open/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-home-roof/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-horizontal-alignment-bottom/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-hourglass/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-images/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-inbox-empty/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-industry/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-jpg/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-key/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-knife-spoon/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-lab/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-law/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-leisure/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-light-bulb-simple/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-lightning/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-line-chart-four/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-line-chart-one/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-line-chart-three/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-line-chart-two/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-lock/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-macbook-air/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-magnifying-glass/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-map-pin/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-megaphone/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-menu-sidebar/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-mic-off/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-mic-on/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-minimize/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-minus-large/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-minus-small/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-money-hand/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-moneybag/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-moon/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-mute/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-office/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-page-add/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-paper-plane-top-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-paperclip/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-pause/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-pdf/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-pencil-sign/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-pencil-sparkle/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-pencil-wave/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-pension/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-people-a11y/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-people-add/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-people-added/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-people-circle/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-people-copy/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-people-profile/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-people-remove/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-people/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-percent/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-phone/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-pie-chart/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-piggy-bank/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-pin/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-pinch/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-play-circle/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-play/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-plus-large/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-plus-small/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-png/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-poop/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-postcard/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-pound/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-power-plant/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-power/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-printer/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-push/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-qr-code/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-rainy/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-raising-hand/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-reading-list/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-receipt-bill/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-receiption-bell/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-record/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-refund/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-robot/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-rocket/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-run-shortcut/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-safari/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-school/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-scissors/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-search-menu/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-settings-gear/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-settings-slider-hor/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-settings-slider-ver/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-shapes/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-share/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-shield-checked/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-shield-crossed/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-shield/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-shopping-bag/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-signature/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-smartwatch/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-solar/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-sort-ascending/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-sort-descending/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-sort-down/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-sort-up/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-sort/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-square-arrow-top-right/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-square-behind-square/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-square-grid-circle/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-square-placeholder/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-star/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-store/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-sun/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-sunset-arrow-down/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-tag/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-target-arrow/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-television/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-tennis/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-text-edit/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-thermostat/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-thumbs-down/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-thumbs-up/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-ticket/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-trading-view-candles/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-trash-can/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-tree/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-trending-five/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-trending-four/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-trending-one/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-trending-three/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-trending-two/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-triangle-exclamation/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-truck/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-umbrella-security/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-unlocked/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-volume-full/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-volume-half/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-volume-off/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-wallet/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-warning-sign/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-wifi-full/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-youtube/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-zap/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-zoom-in/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/icons/icon-zoom-out/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/menu-item/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/menu-heading/index.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/generated/react/option/index.js" } } ] }, { "kind": "javascript-module", "path": "src/primitives/listbox/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/listbox/listbox" } } ] }, { "kind": "javascript-module", "path": "src/primitives/listbox/listbox.component.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/primitives/listbox/listbox.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset, transitional-styles; @layer base { :host { display: flex; flex-direction: column; overflow: auto; overscroll-behavior: contain; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/primitives/listbox/listbox.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/listbox/listbox.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/primitives/listbox/listbox.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/primitives/listbox/listbox.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/listbox/listbox.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsListbox", "declaration": { "name": "GdsListbox", "module": "src/primitives/listbox/listbox.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/listbox/option.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsOption", "slots": [ { "description": "The default slot. Custom content can be used to display the option.", "name": "" } ], "members": [ { "kind": "field", "name": "value", "type": { "text": "any" }, "description": "The value of the option.", "attribute": "value" }, { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "description": "Controls whether the option is visible or not.", "attribute": "hidden", "reflects": true }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Returns true if the option is selected.\nSetting this property will select or unselect the option.", "attribute": "aria-selected", "reflects": true }, { "kind": "field", "name": "isPlaceholder", "type": { "text": "boolean" }, "default": "false", "description": "Sets this option as a placeholder.\nA placehodler option does not have a value and will act as the default option.\n\nIn a multiple select listbox, placeholder options will not be rendered in the list.", "attribute": "isPlaceholder", "reflects": true }, { "kind": "field", "name": "parentElement", "readonly": true }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions | undefined" } } ], "inheritedFrom": { "name": "Focusable", "module": "src/utils/mixins/focusable.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when the option is selected.", "name": "gds-select" }, { "name": "gds-blur", "type": { "text": "FocusEvent" }, "description": "Fired when the option loses focus.", "inheritedFrom": { "name": "Focusable", "module": "src/utils/mixins/focusable.ts" } }, { "name": "gds-focus", "type": { "text": "FocusEvent" }, "description": "Fired when the option gains focus.", "inheritedFrom": { "name": "Focusable", "module": "src/utils/mixins/focusable.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "value", "type": { "text": "any" }, "description": "The value of the option.", "fieldName": "value" }, { "name": "hidden", "type": { "text": "boolean" }, "description": "Controls whether the option is visible or not.", "fieldName": "hidden" }, { "name": "aria-selected", "type": { "text": "boolean" }, "default": "false", "description": "Returns true if the option is selected.\nSetting this property will select or unselect the option.", "fieldName": "selected" }, { "name": "isPlaceholder", "type": { "text": "boolean" }, "default": "false", "description": "Sets this option as a placeholder.\nA placehodler option does not have a value and will act as the default option.\n\nIn a multiple select listbox, placeholder options will not be rendered in the list.", "fieldName": "isPlaceholder" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "Focusable", "module": "/src/utils/mixins/focusable" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-option", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsOption", "declaration": { "name": "GdsOption", "module": "src/primitives/listbox/option.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/listbox/option.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset; @layer base { :host(:not(:last-child)) { border-bottom: 1px solid var(--gds-sys-color-border-neutral-02); } :host .item { display: flex; align-items: center; user-select: none; padding-inline: var(--gds-sys-space-m); padding-block: var(--gds-sys-space-s); cursor: pointer; font: var(--gds-sys-text-detail-m-regular); gap: 1ch; max-width: 100%; box-sizing: border-box; position: relative; &::before { content: ' '; display: flex; inset: var(--gds-sys-space-3xs); position: absolute; border: var(--gds-sys-space-4xs) solid currentColor; border-radius: var(--gds-sys-space-xs); opacity: 0; visitility: hidden; pointer-events: none; } } :host([highlighted]) { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-neutral-06) ); color: var(--gds-sys-color-content-neutral-01); } :host(:hover:not([highlighted])) .item { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-neutral-05) ); } :host(:focus-visible) { outline: none; } :host(:focus-visible) div::before { inset: var(--gds-sys-space-3xs); opacity: 1; visivility: visible; } :host([inert]) { display: none; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/primitives/listbox/option.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/listbox/option.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsOption", "declaration": { "name": "GdsOption", "module": "src/primitives/listbox/option.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/menu/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/menu/menu" } } ] }, { "kind": "javascript-module", "path": "src/primitives/menu/menu-heading.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsMenuHeading", "slots": [ { "description": "The default slot for the menu heading content.", "name": "" } ], "members": [ { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-menu-heading", "customElement": true, "attributes": [ { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsMenuHeading", "declaration": { "name": "GdsMenuHeading", "module": "src/primitives/menu/menu-heading.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/menu/menu-heading.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset, transitional-styles; @layer base { :host { cursor: pointer; color: var(--gds-sys-color-content-neutral-02); background-color: var(--gds-sys-color-l2-neutral-01); border-bottom: 1px solid var(--gds-sys-color-border-subtle-01); font: var(--gds-sys-text-detail-s-book); padding-inline: var(--gds-sys-space-s); padding-block: var(--gds-sys-space-xs); } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/primitives/menu/menu-heading.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/menu/menu-heading.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsMenuHeading", "declaration": { "name": "GdsMenuHeading", "module": "src/primitives/menu/menu-heading.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/menu/menu-item.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsMenuItem", "members": [ { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions | undefined" } } ], "inheritedFrom": { "name": "Focusable", "module": "src/utils/mixins/focusable.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "Focusable", "module": "/src/utils/mixins/focusable" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-menu-item", "customElement": true, "events": [ { "name": "gds-blur", "type": { "text": "FocusEvent" }, "inheritedFrom": { "name": "Focusable", "module": "src/utils/mixins/focusable.ts" } }, { "name": "gds-focus", "type": { "text": "FocusEvent" }, "inheritedFrom": { "name": "Focusable", "module": "src/utils/mixins/focusable.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsMenuItem", "declaration": { "name": "GdsMenuItem", "module": "src/primitives/menu/menu-item.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/menu/menu-item.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsMenuItem", "declaration": { "name": "GdsMenuItem", "module": "src/primitives/menu/menu-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/menu/menu.component.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/primitives/menu/menu.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsMenu", "declaration": { "name": "GdsMenu", "module": "src/primitives/menu/menu.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/ripple/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/ripple/ripple" } } ] }, { "kind": "javascript-module", "path": "src/primitives/ripple/ripple.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsRipple", "members": [ { "kind": "field", "name": "onmousedown" }, { "kind": "method", "name": "triggerRipple", "parameters": [ { "name": "x", "optional": true, "type": { "text": "number" } }, { "name": "y", "optional": true, "type": { "text": "number" } } ] }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "attributes": [ { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsRipple", "declaration": { "name": "GdsRipple", "module": "src/primitives/ripple/ripple.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/ripple/ripple.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { --gds-ripple-motion-name: ripple; --gds-ripple-motion: var(--gds-ripple-motion-name) 1.25s cubic-bezier(0.16, 1, 0.3, 1) 0s 1 normal none running; border-radius: var(--gds-sys-space-max); contain: strict; display: grid; place-content: center; height: 100%; inset: 0; overflow: hidden; position: absolute; width: 100%; } div { background-color: currentColor; border-radius: var(--gds-sys-space-max); display: flex; height: 100%; left: calc((-50% + var(--gds-ripple-left)) / 4); opacity: 0; pointer-events: none; position: absolute; top: 0; width: 100%; will-change: transform; } div.gds-ripple-effect { animation: var(--gds-ripple-motion); } @keyframes ripple { from { opacity: 0.2; transform: scale(0.6, 1); } to { opacity: 0; transform: scale(1.25); } } @media (prefers-reduced-motion: reduce) { :host { --gds-ripple-motion-name: none !important; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/primitives/ripple/ripple.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/ripple/ripple.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsRipple", "declaration": { "name": "GdsRipple", "module": "src/primitives/ripple/ripple.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/toggle-controls-base/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/toggle-controls-base/toggle-control-base" } } ] }, { "kind": "javascript-module", "path": "src/primitives/toggle-controls-base/toggle-control-base.component.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/primitives/toggle-controls-base/toggle-control-base.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, a11y; @layer a11y { @media (prefers-reduced-motion: reduce) { .field-label { transition: none; } } } @layer base { * { box-sizing: border-box; } .container { display: flex; gap: var(--_container-gap, var(--gds-sys-space-s)); } .label { display: flex; flex-direction: column; justify-content: center; } slot[name='label']::slotted(*) { font: var(--_font-label, var(--gds-sys-text-detail-m-book)); cursor: inherit; } slot[name='supporting-text']::slotted(*) { font: var(--_font-supporting-text); font-weight: var(--gds-sys-text-weight-regular); } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/primitives/toggle-controls-base/toggle-control-base.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/primitives/toggle-controls-base/toggle-control-base.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsToggleControlBase", "declaration": { "name": "GdsToggleControlBase", "module": "src/primitives/toggle-controls-base/toggle-control-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/card-pattern-01/card-pattern-01.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsCardPattern01", "slots": [ { "description": "Custom header content", "name": "header" }, { "description": "Action items (buttons, links)", "name": "footer" } ], "members": [ { "kind": "field", "name": "title", "type": { "text": "string" }, "default": "''", "description": "The main title of the card", "attribute": "title" }, { "kind": "field", "name": "excerpt", "type": { "text": "string" }, "default": "''", "description": "A brief description or summary text", "attribute": "excerpt" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Optional label text used on the linked card footer decorative element.", "attribute": "label" }, { "kind": "field", "name": "variant", "type": { "text": "Variant" }, "default": "'neutral-01'", "description": "Card background variant", "attribute": "variant" }, { "kind": "field", "name": "tag", "type": { "text": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'" }, "default": "'h2'", "description": "HTML tag for the card title\nControls heading level for accessibility", "attribute": "tag" }, { "kind": "field", "name": "ratio", "type": { "text": "'landscape' | 'square'" }, "default": "'landscape'", "description": "Aspect ratio/format of the card's media section\n- landscape: 16:9 or similar horizontal format\n- square: 1:1 square format", "attribute": "aspect-ratio" }, { "kind": "field", "name": "category", "type": { "text": "string" }, "default": "''", "description": "Category", "attribute": "category" }, { "kind": "field", "name": "date", "type": { "text": "string" }, "default": "''", "description": "Date", "attribute": "date" }, { "kind": "field", "name": "dateFormat", "type": { "text": "DateTimeFormat" }, "default": "'dateTimeLong'", "description": "Date format to use for displaying the date. Check the GdsFormattedDate component for more details on accepted formats.", "attribute": "date-format" }, { "kind": "field", "name": "locale", "type": { "text": "string" }, "default": "'en-GB'", "description": "Locale for date formatting (e.g., 'sv-SE', 'en-GB', 'en-US')", "attribute": "locale" }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "description": "URL that the link points to\nCan be absolute, relative, or fragment identifier", "attribute": "href", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Specifies where to open the linked document", "attribute": "target", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "description": "Specifies the relationship between the current document and the linked document\nAutomatically adds security-related values when target=\"_blank\"", "attribute": "rel", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "#rel", "privacy": "private", "type": { "text": "string | undefined" }, "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "download", "type": { "text": "string | boolean | undefined" }, "description": "When present, indicates that the linked resource should be downloaded", "attribute": "download", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "ping", "type": { "text": "string | undefined" }, "description": "Specifies a space-separated list of URLs to which, when the link is followed,\nPOST requests with the body ping will be sent by the browser.", "attribute": "ping", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "src", "type": { "text": "string | undefined" }, "description": "The URL of the image", "attribute": "src", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "field", "name": "srcset", "type": { "text": "string | undefined" }, "description": "The srcset attribute for responsive images\nFormat: \"image.jpg 1x, image-2x.jpg 2x\" or \"image-320.jpg 320w, image-640.jpg 640w\"", "attribute": "srcset", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "field", "name": "sizes", "type": { "text": "string | undefined" }, "description": "The sizes attribute for responsive images\nFormat: \"(max-width: 320px) 280px, (max-width: 640px) 580px, 800px\"", "attribute": "sizes", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "field", "name": "alt", "type": { "text": "string | undefined" }, "description": "Alternative text description of the image\nRequired for accessibility. Should be empty string if image is decorative.", "attribute": "alt", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "field", "name": "loading", "type": { "text": "'lazy' | 'eager' | undefined" }, "default": "'lazy'", "description": "Loading strategy for the image", "attribute": "loading", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "field", "name": "decoding", "type": { "text": "'auto' | 'sync' | 'async' | undefined" }, "default": "'auto'", "description": "Decoding strategy for the image", "attribute": "decoding", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "title", "type": { "text": "string" }, "default": "''", "description": "The main title of the card", "fieldName": "title" }, { "name": "excerpt", "type": { "text": "string" }, "default": "''", "description": "A brief description or summary text", "fieldName": "excerpt" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Optional label text used on the linked card footer decorative element.", "fieldName": "label" }, { "name": "variant", "type": { "text": "Variant" }, "default": "'neutral-01'", "description": "Card background variant", "fieldName": "variant" }, { "name": "tag", "type": { "text": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'" }, "default": "'h2'", "description": "HTML tag for the card title\nControls heading level for accessibility", "fieldName": "tag" }, { "name": "aspect-ratio", "type": { "text": "'landscape' | 'square'" }, "default": "'landscape'", "description": "Aspect ratio/format of the card's media section\n- landscape: 16:9 or similar horizontal format\n- square: 1:1 square format", "fieldName": "ratio" }, { "name": "category", "type": { "text": "string" }, "default": "''", "description": "Category", "fieldName": "category" }, { "name": "date", "type": { "text": "string" }, "default": "''", "description": "Date", "fieldName": "date" }, { "name": "date-format", "type": { "text": "DateTimeFormat" }, "default": "'dateTimeLong'", "description": "Date format to use for displaying the date. Check the GdsFormattedDate component for more details on accepted formats.", "fieldName": "dateFormat" }, { "name": "locale", "type": { "text": "string" }, "default": "'en-GB'", "description": "Locale for date formatting (e.g., 'sv-SE', 'en-GB', 'en-US')", "fieldName": "locale" }, { "name": "href", "type": { "text": "string | undefined" }, "description": "URL that the link points to\nCan be absolute, relative, or fragment identifier", "fieldName": "href", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Specifies where to open the linked document", "fieldName": "target", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "Specifies the relationship between the current document and the linked document\nAutomatically adds security-related values when target=\"_blank\"", "fieldName": "rel", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "download", "type": { "text": "string | boolean | undefined" }, "description": "When present, indicates that the linked resource should be downloaded", "fieldName": "download", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "ping", "type": { "text": "string | undefined" }, "description": "Specifies a space-separated list of URLs to which, when the link is followed,\nPOST requests with the body ping will be sent by the browser.", "fieldName": "ping", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "src", "type": { "text": "string | undefined" }, "description": "The URL of the image", "fieldName": "src", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "srcset", "type": { "text": "string | undefined" }, "description": "The srcset attribute for responsive images\nFormat: \"image.jpg 1x, image-2x.jpg 2x\" or \"image-320.jpg 320w, image-640.jpg 640w\"", "fieldName": "srcset", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "sizes", "type": { "text": "string | undefined" }, "description": "The sizes attribute for responsive images\nFormat: \"(max-width: 320px) 280px, (max-width: 640px) 580px, 800px\"", "fieldName": "sizes", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "alt", "type": { "text": "string | undefined" }, "description": "Alternative text description of the image\nRequired for accessibility. Should be empty string if image is decorative.", "fieldName": "alt", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "loading", "type": { "text": "'lazy' | 'eager' | undefined" }, "default": "'lazy'", "description": "Loading strategy for the image", "fieldName": "loading", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "decoding", "type": { "text": "'auto' | 'sync' | 'async' | undefined" }, "default": "'auto'", "description": "Decoding strategy for the image", "fieldName": "decoding", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLinkProps", "module": "/src/utils/mixins/props-link" }, { "name": "withImageProps", "module": "/src/utils/mixins/props-image" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-card-pattern-01", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsCardPattern01", "declaration": { "name": "GdsCardPattern01", "module": "src/patterns/card-pattern-01/card-pattern-01.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/card-pattern-01/card-pattern-01.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Patterns/Card Pattern 01', component: 'gds-card-pattern-01', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-card-pattern-01'), aspectRatio: { control: 'select', options: ['landscape', 'square'], description: 'Aspect ratio for the image', table: { defaultValue: { summary: 'landscape' }, }, }, }, }", "description": "\nFeatures:\n- Linked and non-linked variants\n- Header with image or custom content\n- Configurable image aspect ratio\n- Optional footer with actions\n- Explicit variant tokens\n\nSlots:\n- header: Custom header content\n- footer: Action items (buttons, links)" }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ args: { href: '#', title: 'Card Title', excerpt: 'Card description with label in footer.', label: 'Read more', src: 'https://api.seb.io/assets/launch-hero.jpg', 'max-width': '320px', }, parameters: { docs: { description: { story: 'Linked card with image, title, excerpt, and footer label.', }, source: { code: ` `, language: 'html', type: 'code', }, }, }, }" }, { "kind": "variable", "name": "Header", "type": { "text": "Story" }, "default": "{ render: () => html` `, parameters: { docs: { description: { story: ` - Basic: Text-only layout for simple content - Image: Image-based presentation - Custom: Slotted content when no image present `, }, source: { code: ` `, language: 'html', type: 'code', }, }, }, }" }, { "kind": "variable", "name": "Image", "type": { "text": "Story" }, "default": "{ render: () => html` `, parameters: { docs: { description: { story: ` - Landscape (16:9): Default for featured content - Square (1:1): Alternative for specific layouts - Responsive images with srcset/sizes - Accessibility: Alt text inherits from card's alt property - Performance: Supports loading=\"lazy\" and decoding=\"async\" attributes Note: Image properties can be set directly on the card: \\`\\`\\`html \\`\\`\\` `, }, source: { code: ` `, language: 'html', type: 'code', }, }, }, }" }, { "kind": "variable", "name": "Content", "type": { "text": "Story" }, "default": "{ render: () => html` `, parameters: { docs: { description: { story: ` - Title tag: Supports h1-h6 (default: h2) for proper document structure, it does not affect the font size - Excerpt: Optional description with 3-line limit and ellipsis - Label: Custom text for linked card's footer (requires href) \\`\\`\\`html \\`\\`\\` `, }, source: { code: ` `, language: 'html', type: 'code', }, }, }, }" }, { "kind": "variable", "name": "Footer", "type": { "text": "Story" }, "default": "{ render: () => html` `, parameters: { docs: { description: { story: ` - Default: Non-interactive link indicator - Decorative: Visual elements without interaction - Clean: No footer elements > Note: When href is present, all footer content is inert as the entire card becomes clickable `, }, source: { code: ` `, language: 'html', type: 'code', }, }, }, }" }, { "kind": "variable", "name": "Actions", "type": { "text": "Story" }, "default": "{ render: () => html` Primary Secondary Action Navigate Navigate `, parameters: { docs: { description: { story: ` - Multiple Buttons: For separate clickable actions - Single link: For standalone navigation - Combined: Mix of button and link interactions > Note: Without href, each footer element is independently interactive `, }, source: { code: ` Primary Secondary Action Navigate Navigate `, language: 'html', type: 'code', }, }, }, }" }, { "kind": "variable", "name": "Variant", "type": { "text": "Story" }, "default": "{ render: () => html` Linked Static `, parameters: { docs: { source: { code: ` `, language: 'html', type: 'code', }, }, }, }" }, { "kind": "variable", "name": "Theme", "type": { "text": "Story" }, "default": "{ render: () => html` Light Dark `, parameters: { docs: { description: { story: 'Cards automatically adapt to light and dark themes when wrapped in `gds-theme` provider.', }, source: { code: ` `, language: 'html', type: 'code', }, }, }, }" }, { "kind": "variable", "name": "Metadata", "type": { "text": "Story" }, "default": "{ render: () => html` `, parameters: { docs: { description: { story: ` Metadata attributes provide contextual information and help organize card content. **Category:** Classifies the content type for filtering and organization. **Date:** Publication date in ISO 8601 format. Formatted using \\`gds-formatted-date\\` component with configurable format and locale. **Date Format:** Controls the date and time display format (default: \\`dateLong\\`) **Locale:** Controls the language and regional formatting (default: \\`en-GB\\`) `, }, source: { code: ` `, language: 'html', type: 'code', }, }, }, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/patterns/card-pattern-01/card-pattern-01.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/patterns/card-pattern-01/card-pattern-01.stories.ts" } }, { "kind": "js", "name": "Header", "declaration": { "name": "Header", "module": "src/patterns/card-pattern-01/card-pattern-01.stories.ts" } }, { "kind": "js", "name": "Image", "declaration": { "name": "Image", "module": "src/patterns/card-pattern-01/card-pattern-01.stories.ts" } }, { "kind": "js", "name": "Content", "declaration": { "name": "Content", "module": "src/patterns/card-pattern-01/card-pattern-01.stories.ts" } }, { "kind": "js", "name": "Footer", "declaration": { "name": "Footer", "module": "src/patterns/card-pattern-01/card-pattern-01.stories.ts" } }, { "kind": "js", "name": "Actions", "declaration": { "name": "Actions", "module": "src/patterns/card-pattern-01/card-pattern-01.stories.ts" } }, { "kind": "js", "name": "Variant", "declaration": { "name": "Variant", "module": "src/patterns/card-pattern-01/card-pattern-01.stories.ts" } }, { "kind": "js", "name": "Theme", "declaration": { "name": "Theme", "module": "src/patterns/card-pattern-01/card-pattern-01.stories.ts" } }, { "kind": "js", "name": "Metadata", "declaration": { "name": "Metadata", "module": "src/patterns/card-pattern-01/card-pattern-01.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/card-pattern-01/card-pattern-01.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { display: inline-block; height: max-content; text-align: left; } .card-media { transition-timing-function: var(--gds-sys-motion-easing-linear); transition-duration: var(--gds-sys-motion-duration-fast); transition-property: opacity; @starting-style { opacity: 0; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/patterns/card-pattern-01/card-pattern-01.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/card-pattern-01/card-pattern-01.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsCardPattern01", "declaration": { "name": "GdsCardPattern01", "module": "src/patterns/card-pattern-01/card-pattern-01.ts" } } ] }, { "kind": "javascript-module", "path": "src/patterns/card-pattern-01/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/patterns/card-pattern-01/card-pattern-01" } } ] }, { "kind": "javascript-module", "path": "src/components/alert/alert.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsAlert", "slots": [ { "description": "Alert message content", "name": "" } ], "members": [ { "kind": "field", "name": "variant", "type": { "text": "'information' | 'notice' | 'positive' | 'warning' | 'negative'" }, "default": "'information'", "description": "The variant of the alert, which determines its appearance and icon.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label for the alert, used for accessibility purposes.\nThis needs be set to something relevant to the content of the alert.", "attribute": "label" }, { "kind": "field", "name": "role", "type": { "text": "'alert' | 'status'" }, "default": "'alert'", "description": "The role of the alert, which can be 'alert' or 'status'.\n'alert' is used for critical messages that require immediate attention,\nwhile 'status' is for informational messages. These corresponds to the\nARIA roles, which you can read more about on MDN:\nhttps://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/alert_role\nhttps://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/status_role", "attribute": "role", "reflects": true }, { "kind": "field", "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "The dismissibility of the alert, which determines whether it can be closed by the user.", "attribute": "dismissible" }, { "kind": "field", "name": "timeout", "type": { "text": "number" }, "default": "0", "description": "The time in milliseconds after which the alert will automatically dismiss itself.\nSet to 0 to disable auto-dismiss.", "attribute": "timeout" }, { "kind": "field", "name": "buttonLabel", "type": { "text": "string" }, "default": "''", "description": "The text for the action button, if provided.\nIf not set, no action button will be rendered.", "attribute": "button-label" }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when alert is dismissed", "name": "gds-close" }, { "description": "Fired when action button is clicked", "name": "gds-action" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "variant", "type": { "text": "'information' | 'notice' | 'positive' | 'warning' | 'negative'" }, "default": "'information'", "description": "The variant of the alert, which determines its appearance and icon.", "fieldName": "variant" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label for the alert, used for accessibility purposes.\nThis needs be set to something relevant to the content of the alert.", "fieldName": "label" }, { "name": "role", "type": { "text": "'alert' | 'status'" }, "default": "'alert'", "description": "The role of the alert, which can be 'alert' or 'status'.\n'alert' is used for critical messages that require immediate attention,\nwhile 'status' is for informational messages. These corresponds to the\nARIA roles, which you can read more about on MDN:\nhttps://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/alert_role\nhttps://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/status_role", "fieldName": "role" }, { "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "The dismissibility of the alert, which determines whether it can be closed by the user.", "fieldName": "dismissible" }, { "name": "timeout", "type": { "text": "number" }, "default": "0", "description": "The time in milliseconds after which the alert will automatically dismiss itself.\nSet to 0 to disable auto-dismiss.", "fieldName": "timeout" }, { "name": "button-label", "type": { "text": "string" }, "default": "''", "description": "The text for the action button, if provided.\nIf not set, no action button will be rendered.", "fieldName": "buttonLabel" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-alert", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsAlert", "declaration": { "name": "GdsAlert", "module": "src/components/alert/alert.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/alert/alert.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Alert', component: 'gds-alert', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-alert'), }, args: { variant: 'information', role: 'alert', buttonLabel: '', innerHTML: 'Information Body text starts on the same row as heading. A link (optional) always ends the message.', }, }", "description": "Alert is a message used to inform or update the user about the state of a system, page or function. Icons and color indicate the type and urgency of the information within the message." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ parameters: { docs: { source: { format: true, type: 'dynamic' }, }, controls: { expanded: true }, }, }" }, { "kind": "variable", "name": "Variants", "type": { "text": "Story" }, "default": "{ render: () => html` Information Body text starts on the same row as heading. A link (optional) always ends the message. Notice Body text with link or additional context. Positive Feedback message with optional CTA. Warning Important information to consider. Negative Error message requiring user attention. `, }", "description": "Alert is avaliable in multiple variants to indicate different types of messages.\nEach variant has a specific color and icon to convey the message type." }, { "kind": "variable", "name": "WithAction", "type": { "text": "Story" }, "default": "{ args: { variant: 'information', buttonLabel: 'Take Action', innerHTML: 'Actionable Alert with a button for quick user interaction.', }, }", "description": "Alerts can have a action button to allow users to take an immediate action." }, { "kind": "variable", "name": "Dismissible", "type": { "text": "Story" }, "default": "{ args: { variant: 'information', dismissible: true, innerHTML: 'Dismissible User can dismiss this alert.', }, }", "description": "Alerts can be dismissed by the user, either by pressing the close button, or by using the Escape key while the alert is focused." }, { "kind": "variable", "name": "AutoDismiss", "type": { "text": "Story" }, "default": "{ args: { variant: 'positive', timeout: 6400, innerHTML: 'Auto Dismiss This alert disappears automatically after a delay.', }, }", "description": "Alerts can automatically dismiss themselves after a specified timeout." }, { "kind": "variable", "name": "RichContent", "type": { "text": "Story" }, "default": "{ args: { variant: 'information', dismissible: true, buttonLabel: 'Learn More', innerHTML: 'Rich Content Includes a link, emphasis, and code.', }, }", "description": "Alerts can contain rich content in the main slot." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/alert/alert.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/alert/alert.stories.ts" } }, { "kind": "js", "name": "Variants", "declaration": { "name": "Variants", "module": "src/components/alert/alert.stories.ts" } }, { "kind": "js", "name": "WithAction", "declaration": { "name": "WithAction", "module": "src/components/alert/alert.stories.ts" } }, { "kind": "js", "name": "Dismissible", "declaration": { "name": "Dismissible", "module": "src/components/alert/alert.stories.ts" } }, { "kind": "js", "name": "AutoDismiss", "declaration": { "name": "AutoDismiss", "module": "src/components/alert/alert.stories.ts" } }, { "kind": "js", "name": "RichContent", "declaration": { "name": "RichContent", "module": "src/components/alert/alert.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/alert/alert.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { box-sizing: border-box; display: block; max-width: 100%; container-type: inline-size; } #alert-message { --grid-areas: 'wrapper cta close'; &.timeout { --grid-areas: 'wrapper cta close' 'progress-bar progress-bar progress-bar'; } display: grid; grid-template-columns: 1fr auto auto; grid-template-areas: var(--grid-areas); min-width: fit-content; position: relative; transition: opacity 0.3s ease-out, transform 0.3s ease-out; gap: 0; } /* Animation */ @media (prefers-reduced-motion: no-preference) { #alert-message { animation: slideIn 0.3s ease-out; } } #alert-message.dismissing { opacity: 0; transform: translateY(-1rem); pointer-events: none; } @media (prefers-reduced-motion: reduce) { #alert-message.dismissing { transform: none; } } @keyframes slideIn { from { opacity: 0; transform: translateY(-0.5rem); } } /* Focus styles */ #alert-message:focus { outline: 2px solid var(--gds-focus-color, #000); outline-offset: 2px; } .wrapper { grid-area: wrapper; display: flex; gap: var(--gds-sys-space-xs); .message { max-width: 80ch; } } .dismissible .wrapper { margin-top: var(--gds-sys-space-3xs); } .has-action { padding: var(--gds-sys-space-s) var(--gds-sys-space-m); } .has-action .wrapper { margin-top: var(--gds-sys-space-xs); } .has-action.dismissible .close { margin-top: var(--gds-sys-space-3xs); } .message { font: var(--gds-sys-text-body-m-regular); display: flex; justify-content: flex-start; text-align: left; margin-inline-end: auto; } .message-text { display: inline; white-space: normal; padding-inline-end: var(--gds-sys-space-xs); } .message-text ::slotted(strong) { font-weight: var(--gds-sys-text-weight-book, 450); } .progress-container { --_fill-color: var(--gds-sys-color-border-neutral-04); --_container-color: var(--gds-sys-color-l3-information-03); &.notice { --_fill-color: var(--gds-sys-color-content-notice-01); --_container-color: var(--gds-sys-color-l3-notice-03); } &.warning { --_fill-color: var(--gds-sys-color-content-warning-01); --_container-color: var(--gds-sys-color-l3-warning-03); } &.positive { --_fill-color: var(--gds-sys-color-content-positive-01); --_container-color: var(--gds-sys-color-l3-positive-03); } &.negative { --_fill-color: var(--gds-sys-color-content-negative-01); --_container-color: var(--gds-sys-color-l3-negative-03); } grid-area: progress-bar; margin-top: var(--gds-sys-space-m); inset: auto var(--gds-sys-space-m) var(--gds-sys-space-m); height: 0.25rem; background: var(--_container-color); border-radius: var(--gds-sys-radius-max); overflow: hidden; } .timer-progress { height: 100%; transition: width 0.1s linear; background: var(--_fill-color); will-change: width; } @media (prefers-reduced-motion: reduce) { .timer-progress { transition: none; } } @container (max-width: 600px) { #alert-message { --grid-areas: 'wrapper close' 'cta cta'; &.timeout { --grid-areas: 'wrapper close' 'progress-bar progress-bar'; } .action { grid-area: cta; margin-top: var(--gds-sys-space-xs); } } } /* Medium: inline */ @container (min-width: 601px) and (max-width: 1024px) { #alert-message { .close { margin-left: var(--gds-sys-space-xs); } } } /* Large: centered */ @container (min-width: 1025px) { #alert-message { grid-template-columns: auto auto min-content; &.dismissible:not(.has-action) { grid-template-columns: 1fr auto; } &.dismissible:not(.has-action) .wrapper { margin-inline-start: 0; } .close { margin-left: var(--gds-sys-space-xs); } .icon { margin-inline-start: auto; } .wrapper { margin-left: auto; } .action { margin-right: auto; } } } /* High contrast mode support */ @media (prefers-contrast: high) { .icon { forced-color-adjust: none; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/alert/alert.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/alert/alert.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsAlert", "declaration": { "name": "GdsAlert", "module": "src/components/alert/alert.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/alert/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/alert/alert" } } ] }, { "kind": "javascript-module", "path": "src/components/badge/badge.component.ts", "declarations": [ { "kind": "class", "description": "`gds-badge`", "name": "GdsBadge", "members": [ { "kind": "field", "name": "variant", "type": { "text": "| 'information'\n | 'notice'\n | 'positive'\n | 'warning'\n | 'negative'\n | 'disabled'" }, "default": "'information'", "attribute": "variant" }, { "kind": "field", "name": "size", "type": { "text": "'default' | 'small'" }, "default": "'default'", "attribute": "size" }, { "kind": "field", "name": "notification", "type": { "text": "boolean" }, "default": "false", "attribute": "notification", "reflects": true }, { "kind": "field", "name": "rounded", "type": { "text": "boolean" }, "default": "false", "attribute": "rounded", "reflects": true }, { "kind": "field", "name": "mainSlotOccupied", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "leadSlotOccupied", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "variant", "type": { "text": "| 'information'\n | 'notice'\n | 'positive'\n | 'warning'\n | 'negative'\n | 'disabled'" }, "default": "'information'", "fieldName": "variant" }, { "name": "size", "type": { "text": "'default' | 'small'" }, "default": "'default'", "fieldName": "size" }, { "name": "notification", "type": { "text": "boolean" }, "default": "false", "fieldName": "notification" }, { "name": "rounded", "type": { "text": "boolean" }, "default": "false", "fieldName": "rounded" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-badge", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsBadge", "declaration": { "name": "GdsBadge", "module": "src/components/badge/badge.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/badge/badge.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Badge', component: 'gds-badge', parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-badge'), }, }", "description": "A compact visual indicator for status, counts and notifications.\n\nFeatures:\n- **Variants**: The badge supports multiple variants including `information`, `notice`, `positive`, `warning`, and `negative`, allowing for different contextual uses.\n- **Slots**: The badge includes a `lead` slot for adding leading content such as icons, enhancing the visual representation.\n- **Disabled State**: The badge can be disabled, making it non-interactive and visually indicating its disabled state.\n- **Size Control**: The badge size can be controlled via the `size` property, with options for `default` and `small`.\n\nExample usage:\n\n```html\n\n \n Launch\n\n```" }, { "kind": "variable", "name": "Variants", "type": { "text": "Story" }, "default": "{ name: 'Variants', render: (args) => html` Icon Information Notice Positive Warning Negative Disabled Basic Information Notice Positive Warning Negative Disabled Small 120 428 32 602 537 982 Notification 9 999+ `, }" }, { "kind": "variable", "name": "Lead", "type": { "text": "Story" }, "default": "{ name: 'Lead', parameters: { controls: { include: [] }, }, render: (args) => html` Launch Discard `, }", "description": "The `gds-badge` component includes a `lead` slot that allows for the addition of leading content, such as icons.\n\nThis slot can be used to enhance the visual representation of the badge by including elements like `gds-icon`.\n\nExample usage:\n\n```html\n\n \n Launch\n\n\n \n Discard\n\n```" }, { "kind": "variable", "name": "Trail", "type": { "text": "Story" }, "default": "{ name: 'Trail', parameters: { controls: { include: [] }, }, render: (args) => html` 10,000.00 SEK 142.00 EUR `, }", "description": "`gds-badge` has a trail slot that can be used to add additional content to the badge.\n\n```html\n\n ...\n\n```" }, { "kind": "variable", "name": "Size", "type": { "text": "Story" }, "default": "{ name: 'Size', render: (args) => html` 140 140 140 140 140 kr kr kr kr kr `, }", "description": "Defines the size of the badge.\nThe default value is `default`." }, { "kind": "variable", "name": "Notification", "type": { "text": "Story" }, "default": "{ name: 'Notification', parameters: { actions: { handles: ['mouseover', 'mouseout'], }, }, play: async () => { document.querySelectorAll('gds-badge[notification]').forEach((badge) => { let interval: number | undefined const startAnimation = () => { const content = badge.textContent?.trim() || '' const numericContent = content.replace(/\\D/g, '') // Remove non-numeric characters if (numericContent && !isNaN(Number(numericContent))) { const targetValue = parseInt(numericContent, 10) let currentValue = 0 interval = window.setInterval(() => { badge.textContent = currentValue.toString() + content.replace(/\\d/g, '') // Preserve non-numeric characters if (currentValue === targetValue) { clearInterval(interval) } else { currentValue++ } }, 50) // Adjust the interval speed as needed } } const stopAnimation = () => { if (interval) { clearInterval(interval) interval = undefined } } badge.addEventListener('mouseover', startAnimation) badge.addEventListener('mouseout', stopAnimation) }) }, render: (args) => html` 9 999 `, }", "description": "The `Notification` story demonstrates the use of the `gds-badge` component in notification mode.\nIn this mode, the badge acts as a notification indicator with only two possible variants: `positive` or `negative`.\n\nExample usage:\n\n```html\n\n ...\n ...\n\n```" }, { "kind": "variable", "name": "Rounded", "type": { "text": "Story" }, "default": "{ name: 'Rounded', parameters: {}, render: (args) => html` Rounded Default 01 02 03 04 05 06 Rounded Small 01 02 03 04 05 06 `, }", "description": "The `Rounded` story demonstrates the use of the `gds-badge` component with the `rounded` property.\n\nWhen set to `true`, the badge will have fully rounded corners.\n\nExample usage:\n\n```html\n 01 \n```" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/badge/badge.stories.ts" } }, { "kind": "js", "name": "Variants", "declaration": { "name": "Variants", "module": "src/components/badge/badge.stories.ts" } }, { "kind": "js", "name": "Lead", "declaration": { "name": "Lead", "module": "src/components/badge/badge.stories.ts" } }, { "kind": "js", "name": "Trail", "declaration": { "name": "Trail", "module": "src/components/badge/badge.stories.ts" } }, { "kind": "js", "name": "Size", "declaration": { "name": "Size", "module": "src/components/badge/badge.stories.ts" } }, { "kind": "js", "name": "Notification", "declaration": { "name": "Notification", "module": "src/components/badge/badge.stories.ts" } }, { "kind": "js", "name": "Rounded", "declaration": { "name": "Rounded", "module": "src/components/badge/badge.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/badge/badge.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer tokens, core, variants, sizes, states, notification; @layer core { :host { display: inline-block; } .badge { display: flex; align-items: center; justify-content: flex-start; gap: var(--gds-sys-space-3xs); padding: var(--_padding); min-height: var(--_block-size); border-radius: var(--_border-radius); width: 100%; min-width: var(--_inline-size); font: var(--_font); background-color: var(--_bg); color: var(--_color); box-sizing: border-box; --_padding: var(--gds-sys-space-4xs) var(--gds-sys-space-xs); --_block-size: var(--gds-sys-space-xs); --_border-radius: var(--gds-sys-space-2xs); --_inline-size: var(--gds-sys-space-l); --_font: var(--gds-sys-text-detail-s-book); } } @layer variants { .badge.information { --_bg: var(--gds-sys-color-l3-information-03); --_color: var(--gds-sys-color-content-information-01); } .badge.notice { --_bg: var(--gds-sys-color-l3-notice-03); --_color: var(--gds-sys-color-content-notice-01); } .badge.positive { --_bg: var(--gds-sys-color-l3-positive-03); --_color: var(--gds-sys-color-content-positive-03); } .badge.warning { --_bg: var(--gds-sys-color-l3-warning-03); --_color: var(--gds-sys-color-content-warning-01); } .badge.negative { --_bg: var(--gds-sys-color-l3-negative-03); --_color: var(--gds-sys-color-content-negative-01); } .badge.disabled { --_bg: var(--gds-sys-color-l3-disabled-03); --_color: var(--gds-sys-color-content-disabled-01); } } @layer sizes { .badge.small { --_padding: var(--gds-sys-space-4xs) var(--gds-sys-space-2xs); --_block-size: var(--gds-sys-space-m); --_border-radius: var(--gds-sys-space-3xs); --_font: var(--gds-sys-text-detail-xs-book); } } @layer notification { .badge.notification { --_padding: var(--gds-sys-space-3xs); --_block-size: var(--gds-sys-space-xs); --_border-radius: var(--gds-sys-space-max); --_inline-size: 0; justify-content: center; gap: 0; --_bg: var(--gds-sys-color-l3-negative-01); --_font: var(--gds-sys-text-detail-xs-book); --_color: var(--gds-sys-color-content-neutral-05); } .badge.notification.with-content { --_padding: var(--gds-sys-space-4xs) var(--gds-sys-space-2xs); --_block-size: var(--gds-sys-space-m); --_inline-size: var(--gds-sys-space-l); } } @layer states { .badge.rounded { --_border-radius: var(--gds-sys-space-max); justify-content: center; } } slot[name='lead']::slotted(*) { line-height: var(--gds-sys-space-m); } :host([notification]) slot[name='trail']::slotted(*) { line-height: var(--gds-sys-space-s); } :host([notification]) slot[name='lead']::slotted(*) { line-height: var(--gds-sys-space-s); } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/badge/badge.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/badge/badge.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsBadge", "declaration": { "name": "GdsBadge", "module": "src/components/badge/badge.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/badge/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/badge/badge" } } ] }, { "kind": "javascript-module", "path": "src/components/blur/blur.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsBlur", "slots": [ { "description": "Content to be blurred.", "name": "" } ], "members": [ { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-blur", "customElement": true, "attributes": [ { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsBlur", "declaration": { "name": "GdsBlur", "module": "src/components/blur/blur.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/blur/blur.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Blur', component: 'gds-blur', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-blur'), }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/blur)\n\nThe Blur component is used to apply a blur effect over content,\noften used to obscure sensitive or background information." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html` Blur `, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/blur/blur.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/blur/blur.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/blur/blur.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { --_blur: 5px; } .blur { filter: blur(var(--_blur)); } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/blur/blur.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/blur/blur.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsBlur", "declaration": { "name": "GdsBlur", "module": "src/components/blur/blur.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/blur/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/blur/blur" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumbs/breadcrumbs.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsBreadcrumbs", "members": [ { "kind": "field", "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size and spacing of separators and breadcrumbs items", "attribute": "size" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "description": "This property allow you to set the accessible label of the breadcrumbs.\nIf not provided, the default label is \"breadcrumbs\".", "attribute": "label" }, { "kind": "field", "name": "breadcrumbItems", "type": { "text": "GdsBreadcrumb[]" }, "readonly": true }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size and spacing of separators and breadcrumbs items", "fieldName": "size" }, { "name": "label", "type": { "text": "string" }, "description": "This property allow you to set the accessible label of the breadcrumbs.\nIf not provided, the default label is \"breadcrumbs\".", "fieldName": "label" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-breadcrumbs", "customElement": true, "summary": "The `gds-breadcrumbs` component is a navigation element\nIt helps users understand their current * location within a hierarchical structure of a website or application.", "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsBreadcrumbs", "declaration": { "name": "GdsBreadcrumbs", "module": "src/components/breadcrumbs/breadcrumbs.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumbs/breadcrumbs.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Breadcrumbs', component: 'gds-breadcrumbs', subcomponents: { GdsBreadcrumb: 'gds-breadcrumb' }, tags: ['autodocs'], }", "description": "\nA breadcrumb is a secondary navigation showing the website hierarchy.\n\n## Features\n- Supports both text-only and icon+text navigation links\n- Responsive design with mobile optimization showing the previous page\n- Configurable sizes (large/small)\n\n## Basic Usage\n\n### Simple breadcrumbs\nThe most basic implementation using text-only links.\n\n```html\n\n Home\n Products\n Category\n Current page\n\n```" }, { "kind": "variable", "name": "Simple", "type": { "text": "Story" }, "default": "{ render: () => html` Home Products Category Current page `, }" }, { "kind": "variable", "name": "WithIcon", "type": { "text": "Story" }, "default": "{ render: () => html` Home Documents Settings Current page `, }", "description": "This example shows how to use icons alongside text in the breadcrumbs item.\nIcons can be used to enhance the visual representation of the breadcrumbs item.\n\n```html\n\n \n \n Home\n \n\n```\n\nFor more information on lead and trail icon, please refer to the [Link documentation](https://storybook.seb.io/latest/core/?path=/docs/components-link--docs)." }, { "kind": "variable", "name": "Size", "type": { "text": "Story" }, "default": "{ render: () => html` Default(large) Home Documents Settings Current page Small Home Documents Settings Current page `, }", "description": "Size of the breadcrumbs can be adjusted using the `size` attribute.
\nThe default size is `large`, but you can set it to `small` for a more compact appearance.\n\n```html\n...\n```" }, { "kind": "variable", "name": "Mobile", "type": { "text": "Story" }, "default": "{ render: () => html` Desktop Home Documents Settings Current page Mobile Home Documents Settings Current page `, }", "description": "Mobile optimization is built into the breadcrumbs component.
\nOn mobile devices, the breadcrumbs will show the previous page instead of the full path.
\nThis is done to save space and make navigation easier on smaller screens." }, { "kind": "variable", "name": "Overflow", "type": { "text": "Story" }, "default": "{ render: () => html` Home Documents Action 1 Action 2 Action 3 Settings Current page `, }", "description": "The breadcrumbs component is designed with flexibility in mind, allowing developers to implement * custom overflow solutions that best fit their specific needs.\n\n### Example\n\n```html\n\n Home\n \n \n \n Current\n\n```" }, { "kind": "variable", "name": "Label", "type": { "text": "Story" }, "default": "{ name: 'Accessible Label', render: (args) => html` Default label Home Products Current page Custom label Home Products Current page `, }", "description": "The breadcrumbs component supports customizing the accessibility label.
\nThis can be useful when you have multiple navigation sections\nor want to provide more specific context for screen readers.\n\n```html\n\n ...\n\n```" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/breadcrumbs/breadcrumbs.stories.ts" } }, { "kind": "js", "name": "Simple", "declaration": { "name": "Simple", "module": "src/components/breadcrumbs/breadcrumbs.stories.ts" } }, { "kind": "js", "name": "WithIcon", "declaration": { "name": "WithIcon", "module": "src/components/breadcrumbs/breadcrumbs.stories.ts" } }, { "kind": "js", "name": "Size", "declaration": { "name": "Size", "module": "src/components/breadcrumbs/breadcrumbs.stories.ts" } }, { "kind": "js", "name": "Mobile", "declaration": { "name": "Mobile", "module": "src/components/breadcrumbs/breadcrumbs.stories.ts" } }, { "kind": "js", "name": "Overflow", "declaration": { "name": "Overflow", "module": "src/components/breadcrumbs/breadcrumbs.stories.ts" } }, { "kind": "js", "name": "Label", "declaration": { "name": "Label", "module": "src/components/breadcrumbs/breadcrumbs.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumbs/breadcrumbs.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset, transitional-styles; @layer base { :host { container-type: inline-size; --_gap: var(--gds-sys-space-s); } nav { display: flex; align-items: center; width: max-content; gap: var(--_gap); font: var(--gds-sys-text-detail-m-book); } .size-small { font: var(--gds-sys-text-detail-s-book); --_gap: var(--gds-sys-space-xs); } .size-small .list { --_gap: var(--gds-sys-space-xs); } .list { display: flex; align-items: center; gap: var(--_gap); list-style: none; margin-block-start: 0; margin-block-end: 0; padding-inline-start: 0; height: max-content; font-weight: inherit; font-size: inherit; line-height: inherit; } ::slotted(*:not(:last-child))::after { content: '/'; display: block; } ::slotted(*:not([gds-element='gds-breadcrumb'])) { display: contents; } .mobile-return { display: none; align-items: center; justify-content: center; } @container (max-width: 400px) { .mobile-return { display: flex; } ::slotted(*[return])::after { display: none; } } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/breadcrumbs/breadcrumbs.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumbs/breadcrumbs.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsBreadcrumbs", "declaration": { "name": "GdsBreadcrumbs", "module": "src/components/breadcrumbs/breadcrumbs.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumbs/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/breadcrumbs/breadcrumbs" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/breadcrumbs/breadcrumb" } } ] }, { "kind": "javascript-module", "path": "src/components/button/button.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsButton", "slots": [ { "description": "Content to be displayed as the button label.", "name": "" }, { "description": "An optional slot that allows a `gds-icon-[ICON_NAME]` element to be placed before the label.", "name": "lead" }, { "description": "An optional slot that allows a `gds-icon-[ICON_NAME]` element to be placed after the label.", "name": "trail" } ], "events": [ { "description": "Fired when the button is clicked.", "name": "click" }, { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "Button", "module": "src/components/button/button.component.ts" }, "tagName": "gds-button", "customElement": true, "summary": "A custom button element that can display a label, lead and trail icons, and a ripple effect on click.", "members": [ { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the button is disabled.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Spread the contents of the button", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "type", "type": { "text": "HTMLButtonElement['type'] | undefined" }, "description": "The type of the button.", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "rank", "type": { "text": "'primary' | 'secondary' | 'tertiary'" }, "default": "'primary'", "description": "The rank of the button. Defaults to \"primary\".", "attribute": "rank", "reflects": true, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "variant", "type": { "text": "| 'brand'\n | 'neutral'\n | 'positive'\n | 'negative'\n | 'notice'\n | 'warning'" }, "default": "'neutral'", "description": "Defines which variant the button belongs to. Defaults to \"neutral\".", "attribute": "variant", "reflects": true, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "size", "type": { "text": "'xs' | 'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "Sets the size of the button. Defaults to \"medium\".", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the button. Use this to add an accessible label to the button when no text is provided in the default slot.", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "wrapped", "type": { "text": "boolean" }, "default": "false", "description": "When set, adds a wrapped class to the button.", "attribute": "wrapped", "reflects": true, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "When set, the underlying button will be rendered as an anchor element.", "attribute": "href", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Where to display the linked URL. Only used when href is present.", "attribute": "target", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked URL as space-separated link types. Only used when href is present. Defaults to \"noreferrer noopener\" for security reasons when target is set.", "attribute": "rel", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "description": "Causes the browser to treat the linked URL as a download. Can be used with or without a filename value. Only used when href is present.", "attribute": "download", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "value", "description": "Get or set the value of the form control.", "attribute": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the button is disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "type", "type": { "text": "HTMLButtonElement['type'] | undefined" }, "description": "The type of the button.", "fieldName": "type", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "rank", "type": { "text": "'primary' | 'secondary' | 'tertiary'" }, "default": "'primary'", "description": "The rank of the button. Defaults to \"primary\".", "fieldName": "rank", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "variant", "type": { "text": "| 'brand'\n | 'neutral'\n | 'positive'\n | 'negative'\n | 'notice'\n | 'warning'" }, "default": "'neutral'", "description": "Defines which variant the button belongs to. Defaults to \"neutral\".", "fieldName": "variant", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "size", "type": { "text": "'xs' | 'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "Sets the size of the button. Defaults to \"medium\".", "fieldName": "size", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the button. Use this to add an accessible label to the button when no text is provided in the default slot.", "fieldName": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "wrapped", "type": { "text": "boolean" }, "default": "false", "description": "When set, adds a wrapped class to the button.", "fieldName": "wrapped", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "href", "type": { "text": "string" }, "default": "''", "description": "When set, the underlying button will be rendered as an anchor element.", "fieldName": "href", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Where to display the linked URL. Only used when href is present.", "fieldName": "target", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked URL as space-separated link types. Only used when href is present. Defaults to \"noreferrer noopener\" for security reasons when target is set.", "fieldName": "rel", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Causes the browser to treat the linked URL as a download. Can be used with or without a filename value. Only used when href is present.", "fieldName": "download", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "value", "description": "Get or set the value of the form control.", "fieldName": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsButton", "declaration": { "name": "GdsButton", "module": "src/components/button/button.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button/button.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Button', component: 'gds-button', parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-button'), rank: { options: ['primary', 'secondary', 'tertiary'], control: { type: 'select' }, }, variant: { options: ['neutral', 'brand', 'positive', 'negative'], control: { type: 'select' }, }, size: { options: ['xs', 'small', 'medium', 'large'], control: { type: 'select' }, }, target: { options: ['_self', '_blank', '_parent', '_top'], control: { type: 'select' }, }, rel: { control: { type: 'text' }, }, download: { control: { type: 'text' }, }, }, }", "description": "A button can be tapped or clicked to perform an action." }, { "kind": "variable", "name": "DefaultParams", "type": { "text": "Story" }, "default": "{ parameters: { docs: { source: { format: true, type: 'dynamic' }, }, controls: { expanded: true }, }, args: { innerText: 'Button', }, }" }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "RanksAndVariants", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Ranks and variants', parameters: { ...DefaultParams.parameters, controls: { include: [] }, }, render: (args) => html` Neutral Primary Secondary Tertiary Brand Primary Secondary Tertiary Positive Primary Secondary Tertiary Negative Primary Secondary Tertiary Notice Primary Secondary Tertiary Warning Primary Secondary Tertiary `, }", "description": "Buttons can have different ranks and variants. The rank defines the visual importance of the button,\nwhile the variant defines the intent of the button." }, { "kind": "variable", "name": "Sizes", "type": { "text": "Story" }, "default": "{ ...DefaultParams, parameters: { ...DefaultParams.parameters, controls: { include: ['rank', 'variant'] }, }, render: (args) => html` Large Medium Small XS Large Medium Small XS `, }", "description": "Buttons can be small, medium or large. The default size is medium." }, { "kind": "variable", "name": "WithIcon", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Using icons in button', parameters: { ...DefaultParams.parameters, controls: { include: ['rank', 'variant', 'size'] }, }, render: (args) => html` Leading icon Trailing icon `, }", "description": "Buttons can have an icon on the left or right side of the text. These are called leading or\ntrailing icons, and are added by placing a `gds-icon` component in either the `lead` or `trail`\nslot.\n\nNote that the icons themself does not have a label so if the icon have some meaning,\nshow that on the text or use the label attribute, for it to be read out on screen readers.\n\nIcons that can be used." }, { "kind": "variable", "name": "IconButton", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Icon button', parameters: { ...DefaultParams.parameters, controls: { include: ['rank', 'variant'] }, }, render: (args) => html` `, }", "description": "If a single `gds-icon` is the only child of a button, it will render as a circular\nicon button. Note the icon does not have a aria-label so you have to set the label\nattribute on the button so it reads more than just Button on screen readers.\n\nIcons that can be used." }, { "kind": "variable", "name": "Disabled", "type": { "text": "Story" }, "default": "{ ...DefaultParams, parameters: { ...DefaultParams.parameters, controls: { include: [] }, }, render: () => html` Primary Secondary Tertiary `, }", "description": "The buttons support a disabled state, but in general, it should not be used. It can be\nhard for the user to understand why the button is disabled, so it is often better to\nkeep the button clickable and then show an error message instead." }, { "kind": "variable", "name": "Link", "type": { "text": "Story" }, "default": "{ ...DefaultParams, parameters: { ...DefaultParams.parameters, controls: { include: ['href', 'target', 'rel', 'download'] }, }, args: { href: 'https://github.com/seb-oss/green', }, render: (args) => html` Link `, }", "description": "A link styled as a button." }, { "kind": "variable", "name": "Wrapping", "type": { "text": "Story" }, "default": "{ ...DefaultParams, parameters: { ...DefaultParams.parameters, controls: { include: [] }, }, render: (args) => html` Wrapped Text wraps to multiple lines when exceeding container width Lorem ipsum dolor sit amet, consectetur adipiscing elit. Default Text truncates with ellipsis when exceeding container width Lorem ipsum dolor sit amet, consectetur adipiscing elit. `, }", "description": "Button label will be wrapped if it does not fit." }, { "kind": "variable", "name": "ForwardedAttributes", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Forwarded Attributes', parameters: { ...DefaultParams.parameters, controls: { include: [] }, }, render: () => html` Aria attributes Aria button Tabindex forwarding You can't tab this! `, }", "description": "Some attributes are forwarded to the inner button element by default.\n\nAria attributes such as `label`, `aria-haspopup`, and `aria-expanded` are forwarded to the inner button.\nIf you need to force a certain aria attribute on the inner button, use the `gds-aria-*` attributes on the\n`gds-button` element.\n\nThe `gds-tabindex` attribute can be used to control the inner button tabindex." }, { "kind": "variable", "name": "NextPrevious", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Next & Previous', parameters: { ...DefaultParams.parameters, controls: { include: [] }, }, render: () => html` Spread: Neutral Previous Previous Previous Next Next Next Spread: Positive Previous Previous Previous Next Next Next Spread: Negative Previous Previous Previous Next Next Next `, }", "description": "\nThe `justify-content` property allows control over how content is distributed within buttons.
\nThis is particularly useful for navigation patterns like Next/Previous buttons where you want\nconsistent spacing between icons and text.\n\nUses `justify-content=\"space-between\"` to maximize space between elements\n\nCommon use cases:\n- Navigation buttons (Next/Previous)\n- Buttons with leading/trailing icons that need specific spacing\n\ne.g\n\n```html\n\n\n \n Previous\n\n\n\n\n Next\n \n\n```" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "DefaultParams", "declaration": { "name": "DefaultParams", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "RanksAndVariants", "declaration": { "name": "RanksAndVariants", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "Sizes", "declaration": { "name": "Sizes", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "WithIcon", "declaration": { "name": "WithIcon", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "IconButton", "declaration": { "name": "IconButton", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "Disabled", "declaration": { "name": "Disabled", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "Link", "declaration": { "name": "Link", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "Wrapping", "declaration": { "name": "Wrapping", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "ForwardedAttributes", "declaration": { "name": "ForwardedAttributes", "module": "src/components/button/button.stories.ts" } }, { "kind": "js", "name": "NextPrevious", "declaration": { "name": "NextPrevious", "module": "src/components/button/button.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button/button.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer tokens, core, a11y, ranks, sizes, variants, disabled; @layer a11y { @media (prefers-reduced-motion: reduce) { .button { transition: none; } } } @layer core { :host { display: inline-flex; max-width: 100%; } .button { --_block-size: var(--gds-sys-space-4xl); --_radius: calc((var(--_block-size) + var(--gds-sys-space-xs)) / 1.8); display: flex; align-items: center; justify-content: center; box-sizing: border-box; border: none; cursor: pointer; min-width: 0; background-color: var(--gds-sys-color-l3-neutral-03); color: var(--gds-sys-color-content-neutral-03); border-radius: var(--_radius); font-family: inherit; font: var(--gds-sys-text-detail-m-book); gap: var(--gds-sys-space-xs); outline-color: transparent; outline-offset: var(--gds-sys-space-4xs); outline-style: solid; outline-width: var(--gds-sys-space-4xs); padding-block: var(--gds-sys-space-s); padding-inline: var(--gds-sys-space-xl); position: relative; text-decoration: none; transition-property: color, border-colorm, background; transition-duration: 0.2s; flex: 1; &:focus { outline-color: var(--gds-sys-color-content-neutral-01); &:not(:focus-visible) { outline-color: transparent; } } @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-neutral-03), var(--gds-sys-color-state-neutral-01) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-neutral-03), var(--gds-sys-color-state-neutral-02) ); } &:not(.circle, .wrapped) slot:not([name]) { display: block; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; min-width: 0; } &:not(.wrapped) { block-size: var(--_block-size); } &.wrapped { min-block-size: var(--_block-size); } } } .button.circle { aspect-ratio: 1 / 1; padding: 0; min-block-size: var(--_block-size); min-inline-size: var(--_block-size); } .button:disabled { pointer-events: none; background-color: var(--gds-sys-color-l3-disabled-01); color: var(--gds-sys-color-content-disabled-01); } @layer ranks { :host([rank*='secondary']) .button { background-color: var(--gds-sys-color-l3-neutral-02); color: var(--gds-sys-color-content-neutral-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-neutral-02), var(--gds-sys-color-state-neutral-03) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-neutral-02), var(--gds-sys-color-state-neutral-04) ); } } :host([rank*='tertiary']) .button { background-color: transparent; color: var(--gds-sys-color-content-neutral-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-neutral-05) ); } } &:active { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-neutral-06) ); } } } @layer sizes { :host([size='xs']) .button { --_block-size: var(--gds-sys-space-xl); gap: var(--gds-sys-space-3xs); font: var(--gds-sys-text-detail-xs-book); padding-inline: var(--gds-sys-space-s); padding-block: 0; } :host([size='small']) .button { --_block-size: var(--gds-sys-space-2xl); font: var(--gds-sys-text-detail-s-book); gap: var(--gds-sys-space-3xs); padding-block: var(--gds-sys-space-3xs); padding-inline: var(--gds-sys-space-m); } :host([size='medium']) .button { --_block-size: var(--gds-sys-space-3xl); gap: var(--gds-sys-space-2xs); font: var(--gds-sys-text-detail-m-book); padding-inline: var(--gds-sys-space-l); } } @layer variants { .brand { background-color: var(--gds-sys-color-l3-brand-01); &:focus { outline-color: var(--gds-sys-color-content-brand-01); &:not(:focus-visible) { outline-color: transparent; } } @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-brand-01), var(--gds-sys-color-state-brand-01) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-brand-01), var(--gds-sys-color-state-brand-02) ); } &.secondary { background-color: var(--gds-sys-color-l3-neutral-02); color: var(--gds-sys-color-content-neutral-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-neutral-02), var(--gds-sys-color-state-brand-03) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-neutral-02), var(--gds-sys-color-state-brand-04) ); } } &.tertiary { background-color: transparent; color: var(--gds-sys-color-content-neutral-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-brand-05) ); } } &:active { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-brand-06) ); } } } .positive { background-color: var(--gds-sys-color-l3-positive-01); color: var(--gds-sys-color-content-neutral-05); &:focus { outline-color: var(--gds-sys-color-content-positive-01); &:not(:focus-visible) { outline-color: transparent; } } @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-positive-01), var(--gds-sys-color-state-positive-01) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-positive-01), var(--gds-sys-color-state-positive-02) ); } &.secondary { background-color: var(--gds-sys-color-l3-positive-02); color: var(--gds-sys-color-content-positive-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-positive-02), var(--gds-sys-color-state-positive-03) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-positive-02), var(--gds-sys-color-state-positive-04) ); } } &.tertiary { background-color: transparent; color: var(--gds-sys-color-content-positive-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-positive-05) ); } } &:active { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-positive-06) ); } } } .negative { background-color: var(--gds-sys-color-l3-negative-01); color: var(--gds-sys-color-content-neutral-05); &:focus { outline-color: var(--gds-sys-color-content-negative-01); &:not(:focus-visible) { outline-color: transparent; } } @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-negative-01), var(--gds-sys-color-state-negative-01) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-negative-01), var(--gds-sys-color-state-negative-02) ); } &.secondary { background-color: var(--gds-sys-color-l3-negative-02); color: var(--gds-sys-color-content-negative-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-negative-02), var(--gds-sys-color-state-negative-03) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-negative-02), var(--gds-sys-color-state-negative-04) ); } } &.tertiary { background-color: transparent; color: var(--gds-sys-color-content-negative-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-negative-05) ); } } &:active { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-negative-06) ); } } } .notice { background-color: var(--gds-sys-color-l3-notice-01); color: var(--gds-sys-color-content-neutral-05); &:focus { outline-color: var(--gds-sys-color-content-notice-01); &:not(:focus-visible) { outline-color: transparent; } } @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-notice-01), var(--gds-sys-color-state-notice-01) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-notice-01), var(--gds-sys-color-state-notice-02) ); } &.secondary { background-color: var(--gds-sys-color-l3-notice-02); color: var(--gds-sys-color-content-notice-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-notice-02), var(--gds-sys-color-state-notice-03) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-notice-02), var(--gds-sys-color-state-notice-04) ); } } &.tertiary { background-color: transparent; color: var(--gds-sys-color-content-notice-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-notice-05) ); } } &:active { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-notice-06) ); } } } .warning { background-color: var(--gds-sys-color-l3-warning-01); color: var(--gds-sys-color-content-neutral-03); &:focus { outline-color: var(--gds-sys-color-content-warning-01); &:not(:focus-visible) { outline-color: transparent; } } @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-warning-01), var(--gds-sys-color-state-warning-01) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-warning-01), var(--gds-sys-color-state-warning-02) ); } &.secondary { background-color: var(--gds-sys-color-l3-warning-02); color: var(--gds-sys-color-content-warning-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-warning-02), var(--gds-sys-color-state-warning-03) ); } } &:active { background-color: color-mix( in srgb, var(--gds-sys-color-l3-warning-02), var(--gds-sys-color-state-warning-04) ); } } &.tertiary { background-color: transparent; color: var(--gds-sys-color-content-warning-01); @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-warning-05) ); } } &:active { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-warning-06) ); } } } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/button/button.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button/button.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/button/button.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/button/button.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button/button.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsButton", "declaration": { "name": "GdsButton", "module": "src/components/button/button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/button/button" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/calendar.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsCalendar", "members": [ { "kind": "field", "name": "shadowRootOptions", "type": { "text": "ShadowRootInit" }, "static": true, "default": "{ mode: 'open', delegatesFocus: true, }" }, { "kind": "field", "name": "value", "type": { "text": "Date | undefined" }, "description": "The currently selected date.", "attribute": "value" }, { "kind": "field", "name": "min", "default": "new Date(new Date().getFullYear() - 10, 0, 1)", "description": "The minimum date that can be selected.", "attribute": "min" }, { "kind": "field", "name": "max", "default": "new Date(new Date().getFullYear() + 10, 0, 1)", "description": "The maximum date that can be selected.", "attribute": "max" }, { "kind": "field", "name": "focusedDate", "default": "new Date()", "description": "The date that is currently focused.", "attribute": "focusedDate" }, { "kind": "field", "name": "disabledWeekends", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable weekends or not.", "attribute": "disabled-weekends" }, { "kind": "field", "name": "disabledDates", "type": { "text": "Date[] | undefined" }, "description": "An array of dates that should be disabled in the calendar.", "attribute": "disabled-dates" }, { "kind": "field", "name": "focusedMonth", "description": "The month that is currently focused.", "attribute": "focusedMonth" }, { "kind": "field", "name": "focusedYear", "description": "The year that is currently focused.", "attribute": "focusedYear" }, { "kind": "field", "name": "size", "type": { "text": "'small' | 'large'" }, "default": "'large'", "description": "Sets the size of the grid. Defaults to \"large\".", "attribute": "size", "reflects": true }, { "kind": "field", "name": "showWeekNumbers", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show week numbers or not.", "attribute": "showWeekNumbers" }, { "kind": "field", "name": "hideExtraneousDays", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide extraneous days (that fall ouside of current month)", "attribute": "hideExtraneousDays" }, { "kind": "field", "name": "hideDayNames", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the day names shown above the calendar.", "attribute": "hideDayNames" }, { "kind": "field", "name": "customizedDates", "type": { "text": "CustomizedDate[] | undefined" }, "description": "An array of `CustomizedDate` objects that can be used customize the appearance of dates.\nThis can only be set through the property, not through an attribute." }, { "kind": "field", "name": "label", "type": { "text": "string | undefined" }, "description": "The accessible label for the calendar.", "attribute": "label" }, { "kind": "field", "name": "dateLabelTemplate", "description": "A template function to customize the accessible date label." }, { "kind": "method", "name": "getDateCell", "parameters": [ { "name": "dayNumber", "type": { "text": "number" } } ], "description": "Returns the date cell element for the given day number." }, { "kind": "method", "name": "focus" }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when a date is selected.", "name": "change" }, { "description": "Fired when focus is changed. Can be cancelled using `event.preventDefault()`.", "name": "gds-date-focused" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "value", "type": { "text": "Date | undefined" }, "description": "The currently selected date.", "fieldName": "value" }, { "name": "min", "default": "new Date(new Date().getFullYear() - 10, 0, 1)", "description": "The minimum date that can be selected.", "fieldName": "min" }, { "name": "max", "default": "new Date(new Date().getFullYear() + 10, 0, 1)", "description": "The maximum date that can be selected.", "fieldName": "max" }, { "name": "focusedDate", "default": "new Date()", "description": "The date that is currently focused.", "fieldName": "focusedDate" }, { "name": "disabled-weekends", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable weekends or not.", "fieldName": "disabledWeekends" }, { "name": "disabled-dates", "type": { "text": "Date[] | undefined" }, "description": "An array of dates that should be disabled in the calendar.", "fieldName": "disabledDates" }, { "name": "focusedMonth", "description": "The month that is currently focused.", "fieldName": "focusedMonth" }, { "name": "focusedYear", "description": "The year that is currently focused.", "fieldName": "focusedYear" }, { "name": "size", "type": { "text": "'small' | 'large'" }, "default": "'large'", "description": "Sets the size of the grid. Defaults to \"large\".", "fieldName": "size" }, { "name": "showWeekNumbers", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show week numbers or not.", "fieldName": "showWeekNumbers" }, { "name": "hideExtraneousDays", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide extraneous days (that fall ouside of current month)", "fieldName": "hideExtraneousDays" }, { "name": "hideDayNames", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the day names shown above the calendar.", "fieldName": "hideDayNames" }, { "name": "label", "type": { "text": "string | undefined" }, "description": "The accessible label for the calendar.", "fieldName": "label" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-calendar", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsCalendar", "declaration": { "name": "GdsCalendar", "module": "src/components/calendar/calendar.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/calendar.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Calendar', component: 'gds-calendar', parameters: { layout: 'centered', disabledWeekends: true, }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-calendar'), }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/calendar)\n\nThe calendar displays a grid of selectable dates." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { label: 'Calendar', }, }" }, { "kind": "variable", "name": "Minimal", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }", "description": "Use the `hideDayNames` and `hideExtraneousDays` attribute for a condenced version." }, { "kind": "variable", "name": "Small", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }", "description": "Use the `size=\"small` attribute for a smaller version and `showWeekNumbers` to show\nthe week numbers on the left side." }, { "kind": "variable", "name": "Usage", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html`
2025 2026 2027 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
Selected date:
`, }", "description": "This is an example of a simple inline datepicker using the calendar\ncomponent. It demonstrates how to control the view in the calendar,\nhow to react to changes and how to customize dates. It has customizedDates\nwhich makes the grid larger to give space for the indicators.\n\nThis example is written in plain vanilla js/html, but you can adapt it to your\nframework of choice." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/calendar/calendar.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/calendar/calendar.stories.ts" } }, { "kind": "js", "name": "Minimal", "declaration": { "name": "Minimal", "module": "src/components/calendar/calendar.stories.ts" } }, { "kind": "js", "name": "Small", "declaration": { "name": "Small", "module": "src/components/calendar/calendar.stories.ts" } }, { "kind": "js", "name": "Usage", "declaration": { "name": "Usage", "module": "src/components/calendar/calendar.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/calendar.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset; @layer base { .controls { padding-bottom: 0.25rem; margin: 0.5rem 1rem -0.5rem 1rem; } :host { display: flex; justify-content: center; --columns: 7; } table { display: grid; justify-items: center; grid-template-columns: repeat(var(--columns), 1fr); gap: var(--gds-sys-space-xs); border-spacing: var(--gds-sys-space-xs); flex-grow: 1; width: 100%; padding: 1ch; &.small { border-spacing: var(--gds-sys-space-3xs); thead th { width: var(--gds-sys-space-xl); height: var(--gds-sys-space-xl); } tbody tr .week-number { width: var(--gds-sys-space-xl); height: var(--gds-sys-space-xl); font: var(--gds-sys-text-body-s-book); line-height: var(--gds-sys-text-line-height-detail-s); } &.indicators { border-spacing: var(--gds-sys-space-xs) var(--gds-sys-space-l); } } &.show-week-numbers { --columns: 8; } } tr, thead, tbody { display: contents; } th, td { display: flex; align-items: center; justify-content: center; height: var(--gds-sys-space-2xl); width: var(--gds-sys-space-2xl); box-sizing: border-box; user-select: none; } th { font-weight: normal; } td { position: relative; border-width: var(--gds-sys-space-4xs); border-style: solid; border-color: transparent; border-radius: var(--gds-sys-radius-max); transition: background 0.2s; outline-style: solid; outline-color: transparent; outline-width: 0px; outline-offset: var(--gds-sys-space-4xs); &.short { width: var(--gds-sys-space-4xl); } &.wide { width: var(--gds-sys-space-5xl); } &.long { width: var(--gds-sys-space-7xl); } &:not(.disabled):hover, &[aria-selected='true'] { cursor: pointer; } &[aria-selected='true'] { color: var(--gds-sys-color-content-neutral-03); background: var(--gds-sys-color-l3-neutral-03); } &:not(.disabled):hover { background: color-mix( in srgb, transparent, var(--gds-sys-color-state-neutral-05) ); } &[aria-selected='true']:not(.disabled):hover { background: color-mix( in srgb, var(--gds-sys-color-l3-neutral-03), var(--gds-sys-color-state-neutral-01) ); } &.today { border-color: var(--gds-sys-color-border-neutral-04); } &.disabled:not(.week-number) { background: var(--gds-sys-color-l3-disabled-01); color: var(--gds-sys-color-content-disabled-01); cursor: not-allowed; } &.disabled.week-number { color: var(--gds-sys-color-content-neutral-02); cursor: default; } &.outside-month:not(.disabled) { color: var(--gds-sys-color-content-neutral-02); } &[aria-selected='false']:active:not(.disabled) { background: color-mix( in srgb, transparent, var(--gds-sys-color-state-neutral-06) ); } &[aria-selected='true']:active:not(.disabled) { background: color-mix( in srgb, var(--gds-sys-color-l3-neutral-03), var(--gds-sys-color-state-neutral-02) ); } &:focus-visible { outline-color: var(--gds-sys-color-content-neutral-01); outline-width: var(--gds-sys-space-4xs); } &.small { width: var(--gds-sys-space-xl); height: var(--gds-sys-space-xl); font: var(--gds-sys-text-body-s-book); line-height: var(--gds-sys-text-line-height-detail-s); &.short { width: var(--gds-sys-space-2xl); } &.wide { width: var(--gds-sys-space-3xl); } &.long { width: var(--gds-sys-space-6xl); } } .indicator-dot { display: flex; position: absolute; width: var(--gds-sys-space-xs); height: var(--gds-sys-space-xs); border-radius: var(--gds-sys-radius-max); background: var(--gds-sys-color-l3-neutral-03); inset: calc(100% + var(--gds-sys-space-xs)) calc(50% - var(--gds-sys-space-xs) / 2) auto auto; } } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/calendar/calendar.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/calendar.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/calendar/calendar.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/calendar/calendar.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/calendar.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsCalendar", "declaration": { "name": "GdsCalendar", "module": "src/components/calendar/calendar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/functions.ts", "declarations": [ { "kind": "function", "name": "renderMonthGridView", "parameters": [ { "name": "date", "type": { "text": "Date" } }, { "name": "template", "type": { "text": "(weeks: Week[]) => TemplateResult" } } ] } ], "exports": [ { "kind": "js", "name": "renderMonthGridView", "declaration": { "name": "renderMonthGridView", "module": "src/components/calendar/functions.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/calendar/calendar" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.component.ts", "declarations": [ { "kind": "class", "description": "A container for content representing a single entity. e.g. a contact, article, or task.\n\n`gds-card` inherits all properties from `gds-div`, but comes with some predefined defaults\nand a shortcut property for specifying different card variants.", "name": "GdsCard", "members": [ { "kind": "field", "name": "variant", "type": { "text": "Variant" }, "default": "'neutral-01'", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "default": "'m;m{xl}'", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "type": { "text": "string" }, "default": "'m;m{l}'" }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "variant", "type": { "text": "Variant" }, "default": "'neutral-01'", "fieldName": "variant" }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsDiv", "module": "/src/components/div/div.component" }, "tagName": "gds-card", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsCard", "declaration": { "name": "GdsCard", "module": "src/components/card/card.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Card', component: 'gds-card', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-card'), }, }", "description": "The card groups related content into a single container.\n\n`gds-card` inherits all properties from `gds-div`, but comes with some predefined defaults\nand a shortcut property for specifiying different card variants." }, { "kind": "variable", "name": "Card", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { innerHTML: 'Card content', style: 'max-width: 200px', }, }" }, { "kind": "variable", "name": "Variants", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html` neutral-01 neutral-01-2 neutral-02 neutral-02-2 neutral-02-outlined brand-01 brand-02 `, }", "description": "Examples of different color variants" }, { "kind": "variable", "name": "Cardshadow", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Box shadow', render: (args) => html` XS S M L XL 2XL `, }" }, { "kind": "variable", "name": "CardGrid", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Using with Grid', render: (args) => html` Sidebar Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Button Span Columns: [2 / -1] Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Button Span all columns [1 / -1] Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Button `, }", "description": "\nUsing `gds-card` with `gds-grid`\nThe `gds-card` can be used with the `gds-grid` to create a card layout with multiple cards.\nThe `gds-card` and `gds-div` accept properties like `column` and `row` where you can specify the number of columns specified on the grid to span or rows to span in vertical axis like on this example:\n\n```html\n\n```" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/card/card.stories.ts" } }, { "kind": "js", "name": "Card", "declaration": { "name": "Card", "module": "src/components/card/card.stories.ts" } }, { "kind": "js", "name": "Variants", "declaration": { "name": "Variants", "module": "src/components/card/card.stories.ts" } }, { "kind": "js", "name": "Cardshadow", "declaration": { "name": "Cardshadow", "module": "src/components/card/card.stories.ts" } }, { "kind": "js", "name": "CardGrid", "declaration": { "name": "CardGrid", "module": "src/components/card/card.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { --_border: transparent; --_background: var(--gds-sys-color-l2-neutral-01); --_color: var(--gds-sys-color-content-neutral-01); box-sizing: border-box; border-color: var(--_border); background-color: var(--_background); color: var(--_color); border-width: var(--gds-sys-space-5xs); border-style: solid; display: flex; flex-direction: column; } :host([variant='neutral-01']) { --_border: transparent; --_background: var(--gds-sys-color-l2-neutral-01); --_color: var(--gds-sys-color-content-neutral-01); } :host([variant='neutral-01-2']) { --_border: transparent; --_background: var(--gds-sys-color-l2-neutral-01-2); --_color: var(--gds-sys-color-content-neutral-01); } :host([variant='neutral-02']) { --_border: transparent; --_background: var(--gds-sys-color-l2-neutral-02); --_color: var(--gds-sys-color-content-neutral-01); } :host([variant='neutral-02-outlined']) { --_border: var(--gds-sys-color-border-neutral-02); --_background: var(--gds-sys-color-l2-neutral-02); --_color: var(--gds-sys-color-content-neutral-01); } :host([variant='neutral-02-2']) { --_border: transparent; --_background: var(--gds-sys-color-l2-neutral-02-2); --_color: var(--gds-sys-color-content-neutral-01); } :host([variant='brand-01']) { --_border: transparent; --_background: var(--gds-sys-color-l2-brand-01); --_color: var(--gds-sys-color-content-neutral-05); } :host([variant='brand-02']) { --_border: transparent; --_background: var(--gds-sys-color-l2-brand-02); --_color: var(--gds-sys-color-content-brand-02); } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/card/card.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsCard", "declaration": { "name": "GdsCard", "module": "src/components/card/card.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/card/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/card/card" } }, { "kind": "js", "name": "*", "declaration": { "name": "Types", "module": "src/components/card/card.types" } } ] }, { "kind": "javascript-module", "path": "src/components/card-linked/card-linked.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsCardLinked", "members": [ { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "'a'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "description": "URL that the link points to\nCan be absolute, relative, or fragment identifier", "attribute": "href", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Specifies where to open the linked document", "attribute": "target", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "description": "Specifies the relationship between the current document and the linked document\nAutomatically adds security-related values when target=\"_blank\"", "attribute": "rel", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "#rel", "privacy": "private", "type": { "text": "string | undefined" }, "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "download", "type": { "text": "string | boolean | undefined" }, "description": "When present, indicates that the linked resource should be downloaded", "attribute": "download", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "ping", "type": { "text": "string | undefined" }, "description": "Specifies a space-separated list of URLs to which, when the link is followed,\nPOST requests with the body ping will be sent by the browser.", "attribute": "ping", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "variant", "type": { "text": "Variant" }, "default": "'neutral-01'", "attribute": "variant", "reflects": true, "inheritedFrom": { "name": "GdsCard", "module": "src/components/card/card.component.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "default": "'m;m{xl}'", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "type": { "text": "string" }, "default": "'m;m{l}'", "inheritedFrom": { "name": "GdsCard", "module": "src/components/card/card.component.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withLinkProps", "module": "/src/utils/mixins/props-link" } ], "superclass": { "name": "GdsCard", "module": "/src/components/card/card.component" }, "tagName": "gds-card-linked", "customElement": true, "attributes": [ { "name": "href", "type": { "text": "string | undefined" }, "description": "URL that the link points to\nCan be absolute, relative, or fragment identifier", "fieldName": "href", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Specifies where to open the linked document", "fieldName": "target", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "Specifies the relationship between the current document and the linked document\nAutomatically adds security-related values when target=\"_blank\"", "fieldName": "rel", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "download", "type": { "text": "string | boolean | undefined" }, "description": "When present, indicates that the linked resource should be downloaded", "fieldName": "download", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "ping", "type": { "text": "string | undefined" }, "description": "Specifies a space-separated list of URLs to which, when the link is followed,\nPOST requests with the body ping will be sent by the browser.", "fieldName": "ping", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "variant", "type": { "text": "Variant" }, "default": "'neutral-01'", "fieldName": "variant", "inheritedFrom": { "name": "GdsCard", "module": "src/components/card/card.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsCardLinked", "declaration": { "name": "GdsCardLinked", "module": "src/components/card-linked/card-linked.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card-linked/card-linked.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Card/Card Linked', component: 'gds-card-linked', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-card-linked'), }, }" }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ args: { href: '#', innerHTML: 'Linked Card', }, parameters: { docs: { description: { story: 'Basic implementation of a linked card.', }, }, }, }" }, { "kind": "variable", "name": "Target", "type": { "text": "Story" }, "default": "{ render: () => html` Default (Same Window) New Tab (Adds noreferrer noopener automatically) Parent Frame Top Frame `, parameters: { docs: { description: { story: ` - \\`target=\"_self\"\\` (default): Opens in same window/tab - \\`target=\"_blank\"\\`: Opens in new tab (adds security attributes) - \\`target=\"_parent\"\\`: Opens in parent frame - \\`target=\"_top\"\\`: Opens in full window `, }, }, }, }" }, { "kind": "variable", "name": "Downloads", "type": { "text": "Story" }, "default": "{ render: () => html` Download (Browser Named) Download (Custom Name) `, parameters: { docs: { description: { story: ` - \\`download\\`: Browser determines filename - \\`download=\"filename.pdf\"\\`: Suggests specific filename `, }, }, }, }" }, { "kind": "variable", "name": "Security", "type": { "text": "Story" }, "default": "{ render: () => html` External Link (Auto Security) Custom Security Attributes `, parameters: { docs: { description: { story: ` - Automatic \\`noreferrer noopener\\` for external links - Custom \\`rel\\` attribute support - Safe external linking `, }, }, }, }" }, { "kind": "variable", "name": "Accessibility", "type": { "text": "Story" }, "default": "{ render: () => html` Accessible card link `, parameters: { docs: { description: { story: ` - Proper focus management - Screen reader support - ARIA attribute support `, }, }, }, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/card-linked/card-linked.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/card-linked/card-linked.stories.ts" } }, { "kind": "js", "name": "Target", "declaration": { "name": "Target", "module": "src/components/card-linked/card-linked.stories.ts" } }, { "kind": "js", "name": "Downloads", "declaration": { "name": "Downloads", "module": "src/components/card-linked/card-linked.stories.ts" } }, { "kind": "js", "name": "Security", "declaration": { "name": "Security", "module": "src/components/card-linked/card-linked.stories.ts" } }, { "kind": "js", "name": "Accessibility", "declaration": { "name": "Accessibility", "module": "src/components/card-linked/card-linked.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card-linked/card-linked.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { display: contents; --_border: transparent; --_background: var(--gds-sys-color-l2-neutral-01); --_color: var(--gds-sys-color-content-neutral-01); } :host([variant='neutral-02']) { --_border: transparent; --_background: var(--gds-sys-color-l2-neutral-02); --_color: var(--gds-sys-color-content-neutral-01); } :host([variant='neutral-02-outlined']) { --_border: var(--gds-sys-color-border-neutral-02); --_background: var(--gds-sys-color-l2-neutral-02); --_color: var(--gds-sys-color-content-neutral-01); } a { display: flex; flex-direction: column; box-sizing: border-box; border-color: var(--_border); background-color: var(--_background); color: var(--_color); border-width: var(--gds-sys-space-5xs); border-style: solid; text-decoration: none; cursor: pointer; outline: solid var(--gds-sys-space-4xs) transparent; outline-offset: var(--gds-sys-space-4xs); transition-property: all; transition-duration: var(--gds-sys-motion-duration-fastest); transition-timing-function: var(--gds-sys-motion-easing-ease-in); &:focus { outline-color: var(--gds-sys-color-content-neutral-01); outline-offset: var(--gds-sys-space-3xs); &:not(:focus-visible) { outline-color: transparent; } } @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--_background), var(--gds-sys-color-state-neutral-03) ); } } &:active { background-color: color-mix( in srgb, var(--_background), var(--gds-sys-color-state-neutral-04) ); } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/card-linked/card-linked.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card-linked/card-linked.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsCardLinked", "declaration": { "name": "GdsCardLinked", "module": "src/components/card-linked/card-linked.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card-linked/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/card-linked/card-linked" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsCheckbox", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label displayed next to the checkbox button.", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "supportingText", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed below the label.\nThis text provides additional context or information to the user.", "attribute": "supporting-text" }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the checkbox button is checked or not.", "attribute": "checked" }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Indicates the indeterminate state of the checkbox.\nThis state is used when the checkbox represents a group where some but not all\nchild options are selected, such as in hierarchical selections or \"select all\" scenarios.", "attribute": "indeterminate", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the checkbox button is disabled or not.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "value", "description": "Get or set the value of the form control.", "attribute": "value", "type": { "text": "string" }, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ] }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Dispatched when the checkbox is checked or unchecked.", "name": "input" }, { "description": "Dispatched when the checkbox is checked or unchecked.", "name": "change" }, { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label displayed next to the checkbox button.", "fieldName": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "supporting-text", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed below the label.\nThis text provides additional context or information to the user.", "fieldName": "supportingText" }, { "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the checkbox button is checked or not.", "fieldName": "checked" }, { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Indicates the indeterminate state of the checkbox.\nThis state is used when the checkbox represents a group where some but not all\nchild options are selected, such as in hierarchical selections or \"select all\" scenarios.", "fieldName": "indeterminate" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the checkbox button is disabled or not.", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "value", "description": "Get or set the value of the form control.", "fieldName": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsFormControlElement", "module": "/src/components/form/form-control" }, "tagName": "gds-checkbox", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsCheckbox", "declaration": { "name": "GdsCheckbox", "module": "src/components/checkbox/checkbox.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Checkbox', component: 'gds-checkbox-group', subcomponents: { GdsCheckbox: 'gds-checkbox' }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-checkbox-group'), }, }", "description": "A checkbox is a form element that allows users to select one or multiple options.
\nThey can be grouped together using a checkbox group, which makes value management and validation easier.\n\nGroups support vertical and horizontal layouts, and can be sized to fit different space requirements." }, { "kind": "variable", "name": "CheckboxButton", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Checkbox', args: { label: 'Pick an option', supportingText: 'Label support text.', innerHTML: ` `, }, }", "description": "Checkboxes allow users to select one or more option from a list of options.
\nEach checkbox must have both a label and a value.\n\nUsage:\n\n```html\n\n \n \n\n```\n\nInteractive example with supporting texts:" }, { "kind": "variable", "name": "Validation", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Validation', render: () => html`
{ if (el.value!.length < 1) return [ { ...el.validity, valid: false, customError: true }, 'This is required', ] }, }} > Extended supporting text for the group Submit
`, }", "description": "Checkbox groups support validation using Green Core's [form validation API](/docs/components-form-validation-documentation--docs).\n\nThe error message appears below the checkbox group, and can be set either trough a validator, or explicitly using the using the `error-message` attribute.\n\nIf you click on 'submit' first on the example below it will validate the checkbox group and show the error message." }, { "kind": "variable", "name": "DosAndDonts", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: \"Do's and don'ts\", render: () => html` Do provide both Label and Value Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Never exclude the label
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Never exclude the value
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
`, }" }, { "kind": "variable", "name": "Disabled", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Disabled', render: () => html`
Extended supporting text for the group
`, }", "description": "Disabled checkboxes cannot be interacted with and appear visually muted.\n\nIn general, this state should never be used. Instead, aim to explain to the user why the choice is wrong in an error message and make sure they understand how to correct it." }, { "kind": "variable", "name": "Size", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Size', render: () => html`
Size: Large(default) Extended supporting text for the group Size: small Extended supporting text for the group
`, }", "description": "Checkboxes support two sizes:\n- Large (default): Standard size for most use cases\n- Small: Compact size for space-constrained layouts\n\nThe size can be set on the checkbox group and applies to all checkboxes within." }, { "kind": "variable", "name": "Direction", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Direction', render: () => html`
Column (default) Extended supporting text for the group Row Extended supporting text for the group
`, }", "description": "Checkboxes can be arranged in two directions:\n- Column (default): Vertical stacking for clear separation\n- Row: Horizontal alignment for compact layouts that will break to new line when not enough space is available\n\nChoose the direction based on available space and number of options." }, { "kind": "variable", "name": "GroupLabel", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Checkbox group label', render: () => html`



`, }", "description": "While checkbox groups can be created without a label, it's recommended to always provide one for clarity and accessibility.\nThe label helps users understand what the options are for.\n\nIn certain cases when space is limited, the group label can be omitted." }, { "kind": "variable", "name": "Indeterminate", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Indeterminate', render: () => html` `, }", "description": "The indeterminate state is used when a checkbox represents a group of sub-options with mixed selected states.\nCommon use cases include:\n- Parent checkboxes in a tree structure where some but not all children are checked\n- \"Select all\" checkboxes when some items are selected\n- Bulk actions where the selection applies to only some items in a group" }, { "kind": "variable", "name": "SingleCheckbox", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Single checkbox', render: () => html` `, }", "description": "Sometimes you need a single checkbox where the checkbox group label should be visually hidden but still accessible to screen readers.\nIn this case you should still provide a meaningful group label and hide it visually with the `hide-label` attribute or `hideLabel` property.\nCommon use cases include:\n- Confirming that one has read terms and conditions\n- Agreeing to privacy policies\n- Opting into newsletters or marketing communications" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/checkbox/checkbox.stories.ts" } }, { "kind": "js", "name": "CheckboxButton", "declaration": { "name": "CheckboxButton", "module": "src/components/checkbox/checkbox.stories.ts" } }, { "kind": "js", "name": "Validation", "declaration": { "name": "Validation", "module": "src/components/checkbox/checkbox.stories.ts" } }, { "kind": "js", "name": "DosAndDonts", "declaration": { "name": "DosAndDonts", "module": "src/components/checkbox/checkbox.stories.ts" } }, { "kind": "js", "name": "Disabled", "declaration": { "name": "Disabled", "module": "src/components/checkbox/checkbox.stories.ts" } }, { "kind": "js", "name": "Size", "declaration": { "name": "Size", "module": "src/components/checkbox/checkbox.stories.ts" } }, { "kind": "js", "name": "Direction", "declaration": { "name": "Direction", "module": "src/components/checkbox/checkbox.stories.ts" } }, { "kind": "js", "name": "GroupLabel", "declaration": { "name": "GroupLabel", "module": "src/components/checkbox/checkbox.stories.ts" } }, { "kind": "js", "name": "Indeterminate", "declaration": { "name": "Indeterminate", "module": "src/components/checkbox/checkbox.stories.ts" } }, { "kind": "js", "name": "SingleCheckbox", "declaration": { "name": "SingleCheckbox", "module": "src/components/checkbox/checkbox.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { cursor: pointer; } :host([disabled]) { color: var(--gds-sys-color-content-disabled-01); cursor: default; } :host(:invalid) { color: var(--gds-sys-color-content-negative-01); } :host(:focus) { outline: none; } #message { display: none; } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/checkbox/checkbox.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsCheckbox", "declaration": { "name": "GdsCheckbox", "module": "src/components/checkbox/checkbox.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/checkbox/checkbox-group/checkbox-group" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/checkbox/checkbox" } } ] }, { "kind": "javascript-module", "path": "src/components/coachmark/coachmark.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsCoachmark", "slots": [ { "description": "placeholder for the content of the tooltip.", "name": "" } ], "members": [ { "kind": "field", "name": "placement", "type": { "text": "Placement" }, "default": "'bottom'", "description": "The placement of the popover relative to the trigger.\nAccepts any of the placements supported by Floating UI.", "attribute": "placement" }, { "kind": "field", "name": "overlappedBy", "type": { "text": "string[]" }, "default": "[]", "description": "The coachmark will be hidden when overlapped by the list of provided elements (selectors)." }, { "kind": "field", "name": "target", "type": { "text": "string[]" }, "default": "[]", "description": "List of selectors pointing to the targeted element. Ex. for a target inside a ShadowDOM: [\"some-component\", \"shadowRoot\", \"target-element\"]." }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "'Coachmark'", "description": "The accessible label of the coachmark.", "attribute": "label" }, { "kind": "field", "name": "computeVisibility", "type": { "text": "(\n self: GdsCoachmark,\n target: HTMLElement,\n computedVisibility: boolean,\n ) => boolean" }, "description": "A callback that can be used to set the visibility of the coachmark based on your criteria.\n\nThe default computed visibility, based on visibility and overlap of the target element, is supplied as the third argument." }, { "kind": "field", "name": "targetElement", "type": { "text": "HTMLElement | undefined" }, "default": "undefined", "description": "The resolved targeted element (readonly)" }, { "kind": "field", "name": "_isVisible", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "_preventClose", "type": { "text": "boolean" }, "default": "false" }, { "kind": "method", "name": "setPreventClose", "parameters": [ { "name": "preventClose", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "dispatched when the tooltip is about to be closed. Can be cancelled to prevent closing.", "name": "gds-ui-state" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "placement", "type": { "text": "Placement" }, "default": "'bottom'", "description": "The placement of the popover relative to the trigger.\nAccepts any of the placements supported by Floating UI.", "fieldName": "placement" }, { "name": "label", "type": { "text": "string" }, "default": "'Coachmark'", "description": "The accessible label of the coachmark.", "fieldName": "label" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-coachmark", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsCoachmark", "declaration": { "name": "GdsCoachmark", "module": "src/components/coachmark/coachmark.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/coachmark/coachmark.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Coachmark', component: 'gds-coachmark', parameters: { layout: 'centered', }, tags: ['autodocs'], }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/coachmark)\n\nCoachmarks guide users through interface features.\n\nThe component is primarily a container that follows the targeted element.\nThe coachmark will be invisible and disabled if another element covered the targeted element or its simply out of view.\nThe coachmark will close and dispatch a CustomEvent of `gds-ui-state`\n\nNote: the component can only view one coachmark at the time therefore the tooltip won't be\nrendered in second storybook panel and testing the tooltip behaviour will be in the first panel only" }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html`

The coachmark will target the first element that matches the selector. Clicking anywhere closes the coachmark.

Coachmark target element

This is the coachmark content.
`, }", "description": "Because this is the default story that also renders at the top of the page, the\ncoachmark will be shown in the first panel only, since the `#targetElement` selector\nwill match the first element in the DOM." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/coachmark/coachmark.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/coachmark/coachmark.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/coachmark/coachmark.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` #body { visibility: hidden; position: absolute; z-index: 1060; box-sizing: border-box; padding: var(--gds-sys-space-m); width: 20rem; border-radius: var(--gds-sys-radius-s); background-color: var(--gds-sys-color-l2-neutral-03); color: var(--gds-sys-color-content-neutral-05); opacity: 0; transition: opacity 0.3s; } #arrow { box-sizing: border-box; z-index: -1; position: absolute; height: var(--gds-sys-space-m); width: var(--gds-sys-space-m); background-color: var(--gds-sys-color-l2-neutral-03); transform: rotate(45deg); } .arrow-top, .arrow-top-start, .arrow-top-end { bottom: -0.5rem; } .arrow-bottom, .arrow-bottom-start, .arrow-bottom-end { top: -0.5rem; } .arrow-left, .arrow-left-start, .arrow-left-end { right: -0.5rem; } .arrow-right, .arrow-right-start, .arrow-right-end { left: -0.5rem; } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/coachmark/coachmark.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/coachmark/coachmark.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsCoachmark", "declaration": { "name": "GdsCoachmark", "module": "src/components/coachmark/coachmark.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/coachmark/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/coachmark/coachmark" } } ] }, { "kind": "javascript-module", "path": "src/components/context-menu/context-menu.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsContextMenu", "slots": [ { "description": "The default slot. Only `gds-menu-item` elements are accepted here.", "name": "" } ], "members": [ { "kind": "field", "name": "shadowRootOptions", "type": { "text": "ShadowRootInit" }, "static": true, "default": "{ mode: 'open', delegatesFocus: true, }" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the context menu popover is open.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "buttonLabel", "type": { "text": "string" }, "description": "The label for the trigger button.", "attribute": "button-label" }, { "kind": "field", "name": "showLabel", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the label on the trigger button.", "attribute": "show-label" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label for the popover and menu. Should describe the context of the menu.", "attribute": "label" }, { "kind": "field", "name": "maxHeight", "type": { "text": "number" }, "default": "500", "description": "Maximum height of the menu list.", "attribute": "max-height" }, { "kind": "field", "name": "placement", "type": { "text": "Placement" }, "default": "'bottom-start'", "description": "The placement of the popover relative to the trigger.", "attribute": "placement" }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when a menu item is clicked.", "name": "gds-menu-item-click" }, { "description": "Fired when the menu is opened or closed.", "name": "gds-ui-state" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the context menu popover is open.", "fieldName": "open" }, { "name": "button-label", "type": { "text": "string" }, "description": "The label for the trigger button.", "fieldName": "buttonLabel" }, { "name": "show-label", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the label on the trigger button.", "fieldName": "showLabel" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label for the popover and menu. Should describe the context of the menu.", "fieldName": "label" }, { "name": "max-height", "type": { "text": "number" }, "default": "500", "description": "Maximum height of the menu list.", "fieldName": "maxHeight" }, { "name": "placement", "type": { "text": "Placement" }, "default": "'bottom-start'", "description": "The placement of the popover relative to the trigger.", "fieldName": "placement" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-context-menu", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsMenuItem", "declaration": { "name": "GdsMenuItem", "module": "../../primitives/menu/menu-item.component" } }, { "kind": "js", "name": "GdsMenuHeading", "declaration": { "name": "GdsMenuHeading", "module": "../../primitives/menu/menu-heading.component" } }, { "kind": "js", "name": "GdsContextMenu", "declaration": { "name": "GdsContextMenu", "module": "src/components/context-menu/context-menu.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/context-menu/context-menu.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Context menu', component: 'gds-context-menu', subcomponents: { GdsMenuItem: 'gds-menu-item' }, parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-context-menu'), }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/context-menu)\n | \n[Usage guidelines](https://designlibrary.sebgroup.com/components/component-moremenu)\n\nA context menu displays a list of contextual actions." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "Usage", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` Activated action:
Action 1 Action 2 Action 3 `, }", "description": "Menu items are defined by adding `gds-menu-item` elements as children of the `gds-context-menu` element.\nYou should always provide a `button-label` so the button is accessibible. Consider to show the label as\nwell with `show-label` set to `true`;\n\nTo handle the user's interaction, you can listen to `click` events on individual menu items, or to the\n`gds-menu-item-click` event on the parent `gds-context-menu` element.\n\nNote that you should always supply a label for the context menu. The label should describe the context\nof the menu, such as \"Select an action for XYZ\"." }, { "kind": "variable", "name": "CustomTrigger", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` Custom trigger Action 1 Action 2 Action 3 `, }", "description": "You can provide a custom trigger for the context menu by adding an element to the `trigger` slot.\nThe trigger element should be focusable, preferably a `gds-button` element. Appropriate ARIA attributes will be added\nto the trigger element automatically, but misuse of this slot can still result in an inaccessible component." }, { "kind": "variable", "name": "ShowLabel", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` Action 1 Action 2 Action 3 `, }", "description": "You can show the label by setting the `show-label` attribute on the `` element." }, { "kind": "variable", "name": "CustomIcon", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html`
Custom markup can go here if so is needed!
Action 2
Delete 
Custom markup can go here if so is needed!
Action 2
Delete 
`, }", "description": "You can provide a custom icon for the context menu trigger by using the `icon` slot." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/context-menu/context-menu.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/context-menu/context-menu.stories.ts" } }, { "kind": "js", "name": "Usage", "declaration": { "name": "Usage", "module": "src/components/context-menu/context-menu.stories.ts" } }, { "kind": "js", "name": "CustomTrigger", "declaration": { "name": "CustomTrigger", "module": "src/components/context-menu/context-menu.stories.ts" } }, { "kind": "js", "name": "ShowLabel", "declaration": { "name": "ShowLabel", "module": "src/components/context-menu/context-menu.stories.ts" } }, { "kind": "js", "name": "CustomIcon", "declaration": { "name": "CustomIcon", "module": "src/components/context-menu/context-menu.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/context-menu/context-menu.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/context-menu/context-menu.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/context-menu/context-menu.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/context-menu/context-menu.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsContextMenu", "declaration": { "name": "GdsContextMenu", "module": "src/components/context-menu/context-menu.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/context-menu/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/context-menu/context-menu" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/menu/menu-item" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/menu/menu-heading" } } ] }, { "kind": "javascript-module", "path": "src/components/datepicker/date-part-spinner.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/datepicker/datepicker.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsDatepicker", "slots": [ { "description": "A longer supporting text can be placed here. It will be displayed in a panel when the user clicks the info button.", "name": "extended-supporting-text" }, { "description": "***(deprecated - use `errorMessage` property instead)*** Error message to show below the input field whem there is a validation error.", "name": "message" }, { "description": "***(deprecated - use `supporting-text` property instead)*** Renders between the label and the trigger button.", "name": "sub-label" } ], "events": [ { "description": "Fired when the value of the dropdown is changed through user interaction (not when value prop is set programatically).", "name": "change" }, { "description": "Fired when the dropdown is opened or closed.", "name": "gds-ui-state" }, { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" }, "tagName": "gds-datepicker", "customElement": true, "members": [ { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "type", "readonly": true, "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "value", "description": "The Date value of the datepicker. This can be set to undefined to clear the datepicker.\nThis can be a string if set via the value attribute in markup, or via the setAttribute DOM API.", "attribute": "value", "type": { "text": "Date | undefined" }, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "min", "default": "new Date(new Date().getFullYear() - 10, 0, 1)", "description": "The minimum date that can be selected.", "attribute": "min", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "max", "default": "new Date(new Date().getFullYear() + 10, 0, 1)", "description": "The maximum date that can be selected.", "attribute": "max", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the datepicker popover is open.", "attribute": "open", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "supportingText", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field itself", "attribute": "supporting-text", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Whether to use the small variant of the datepicker field.", "attribute": "size", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Hides the header and the footer, while still keeping the accessible label\n\nAlways set the `label` attribute, and if you need to hide it, add this attribute and keep `label` set.", "attribute": "plain", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "showWeekNumbers", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show a column of week numbers in the calendar.", "attribute": "show-week-numbers", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "hideLabel", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the label above the input field.", "attribute": "hide-label", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the Clear button is shown under the calendar.", "attribute": "clearable", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "hideTodayButton", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the Today button under the calendar.", "attribute": "hide-today-button", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "utcHours", "description": "Controls the time component of dates selected in the calendar popover or spinbuttons in the field.\n\nThe time will be set in UTC.", "attribute": "utc-hours", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "dateformat", "description": "The date format to use. Accepts a string with the characters `y`, `m` and `d` in any order, separated by a delimiter.\nFor example, `y-m-d` or `d/m/y`. All three characters must be present.\n\nThis will determine the structure of the input field.\n\nDefaults to `y-m-d`.", "attribute": "dateformat", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "disabledWeekends", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable weekends in the calendar.", "attribute": "disabled-weekends", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "disabledDates", "type": { "text": "Date[] | undefined" }, "description": "An array of dates that should be disabled in the calendar.", "attribute": "disabled-dates", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "showExtendedSupportingText", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "attribute": "show-extended-supporting-text", "reflects": true, "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "method", "name": "getFocusedDate", "return": { "type": { "text": "Promise" } }, "description": "Get the currently focused date in the calendar popover. If no date is focused, or the calendar popover\nis closed, the value will be undefined.", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "displayValue", "description": "Get a string representation of the currently displayed value in the input field. The formatting will match the dateformat attribute.", "readonly": true, "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "test_calendarButton", "type": { "text": "Promise" }, "description": "A reference to the calendar button element inside the shadow root.\nInteded for use in integration tests.", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "test_clearButton", "type": { "text": "HTMLButtonElement" }, "description": "A reference to the clear button element inside the shadow root.\nInteded for use in integration tests.", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "test_todayButton", "type": { "text": "HTMLButtonElement" }, "description": "A reference to the today button element inside the shadow root.\nInteded for use in integration tests.", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "method", "name": "test_getDateCell", "parameters": [ { "name": "dayNumber", "type": { "text": "number" } } ], "description": "A reference to a date cell element () inside the shadow root of the calendar primitive.\nIntended for use in integration tests.", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "value", "description": "The Date value of the datepicker. This can be set to undefined to clear the datepicker.\nThis can be a string if set via the value attribute in markup, or via the setAttribute DOM API.", "fieldName": "value", "type": { "text": "Date | undefined" }, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "min", "default": "new Date(new Date().getFullYear() - 10, 0, 1)", "description": "The minimum date that can be selected.", "fieldName": "min", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "max", "default": "new Date(new Date().getFullYear() + 10, 0, 1)", "description": "The maximum date that can be selected.", "fieldName": "max", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Controls whether the datepicker popover is open.", "fieldName": "open", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "supporting-text", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field itself", "fieldName": "supportingText", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Whether to use the small variant of the datepicker field.", "fieldName": "size", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Hides the header and the footer, while still keeping the accessible label\n\nAlways set the `label` attribute, and if you need to hide it, add this attribute and keep `label` set.", "fieldName": "plain", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "show-week-numbers", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show a column of week numbers in the calendar.", "fieldName": "showWeekNumbers", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "hide-label", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the label above the input field.", "fieldName": "hideLabel", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the Clear button is shown under the calendar.", "fieldName": "clearable", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "hide-today-button", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the Today button under the calendar.", "fieldName": "hideTodayButton", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "utc-hours", "description": "Controls the time component of dates selected in the calendar popover or spinbuttons in the field.\n\nThe time will be set in UTC.", "fieldName": "utcHours", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "dateformat", "description": "The date format to use. Accepts a string with the characters `y`, `m` and `d` in any order, separated by a delimiter.\nFor example, `y-m-d` or `d/m/y`. All three characters must be present.\n\nThis will determine the structure of the input field.\n\nDefaults to `y-m-d`.", "fieldName": "dateformat", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "disabled-weekends", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable weekends in the calendar.", "fieldName": "disabledWeekends", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "disabled-dates", "type": { "text": "Date[] | undefined" }, "description": "An array of dates that should be disabled in the calendar.", "fieldName": "disabledDates", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "show-extended-supporting-text", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "fieldName": "showExtendedSupportingText", "inheritedFrom": { "name": "Datepicker", "module": "src/components/datepicker/datepicker.component.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "fieldName": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsDatepicker", "declaration": { "name": "GdsDatepicker", "module": "src/components/datepicker/datepicker.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/datepicker/datepicker.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Datepicker', component: 'gds-datepicker', parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-datepicker'), }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/datepicker)\n | \n[Usage guidelines](https://designlibrary.sebgroup.com/components/datepicker)\n\nThe datepicker allows users to select a date.\n\nThe datepicker in Green Core mimics the behaviour of the native date input element as it is\nimplemented in Chromium browsers.\n\nThe input field shows three parts of the date: the day, the month and the year. The user can\nnavigate between these parts using the arrow keys. The user can also navigate between the parts\nby clicking on them or tabbing. When a part has focus, it can be changed using the arrow keys or\nby typing a number.\n\nClicking the calendar icon opens a popover with a calendar view where a date can be chosen." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "Usage", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }", "description": "The date picker takes a `label` attribute for setting the label text, and\na `supporting-text` attribute for setting the supporting text below the label.\n\nWhen the value is changed by a user, a `change` event is fired." }, { "kind": "variable", "name": "WeekNumbers", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }", "description": "Use the `show-week-numbers` attribute to show a week numbers column in the calendar view." }, { "kind": "variable", "name": "MinMaxDates", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Min and max dates', render: (args) => html` `, }", "description": "Setting `min` and `max` date you can choose." }, { "kind": "variable", "name": "Disabled", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }", "description": "Set the `disable-weekends` attribute to disable weekends (saturdays and sundays) in the calendar view.\n\nAdditionally, `disabled-dates` can be used to disable specific dates.\n\n- When set via the `disabled-dates` attribute, this should be a comma-separated list of date strings that can be parsed by the Javscript `Date()` constructor.\n- When set via the `disabledDates` property, it should be an array of Javascript `Date` objects." }, { "kind": "variable", "name": "InputFieldSize", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }", "description": "The date picker has two sizes: `small` and `large`. The default size is `large`.\n\nOptionally, the label can be hidden by using the `hide-label` attribute." }, { "kind": "variable", "name": "Invalid", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }" }, { "kind": "variable", "name": "DisabledField", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Disabled', render: (args) => html` `, }", "description": "Use the `show-week-numbers` attribute to show a week numbers column in the calendar view." }, { "kind": "variable", "name": "Clearable", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }", "description": "The selected date can be clearable by using the 'clearable` attribute (was default on before)." }, { "kind": "variable", "name": "Simplified", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }", "description": "The today button can be hidden by using the `hide-today-button` attribute." }, { "kind": "variable", "name": "Full", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }", "description": "An example with things turned on." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "Usage", "declaration": { "name": "Usage", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "WeekNumbers", "declaration": { "name": "WeekNumbers", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "MinMaxDates", "declaration": { "name": "MinMaxDates", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "Disabled", "declaration": { "name": "Disabled", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "InputFieldSize", "declaration": { "name": "InputFieldSize", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "Invalid", "declaration": { "name": "Invalid", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "DisabledField", "declaration": { "name": "DisabledField", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "Clearable", "declaration": { "name": "Clearable", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "Simplified", "declaration": { "name": "Simplified", "module": "src/components/datepicker/datepicker.stories.ts" } }, { "kind": "js", "name": "Full", "declaration": { "name": "Full", "module": "src/components/datepicker/datepicker.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/datepicker/datepicker.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset; @layer base { #calendar-button::part(_button) { outline-offset: -1px; } .spinners { display: flex; align-items: center; justify-content: flex-start; inline-size: 12ch; gap: var(--gds-sys-space-5xs); font: var(--gds-sys-text-detail-m-regular); } :host([size='small']) .spinners { font: var(--gds-sys-text-detail-s-regular); } .spinner { display: flex; align-items: center; justify-content: center; text-align: center; height: 100%; box-sizing: border-box; outline: none; padding-block: var(--gds-sys-space-4xs); text-transform: uppercase; line-height: 1; text-align: center; padding: var(--gds-sys-space-4xs); margin: calc(-1 * var(--gds-sys-space-4xs)); border-radius: var(--gds-sys-radius-3xs); &:focus { background-color: var(--gds-sys-color-l3-neutral-03); color: var(--gds-sys-color-content-neutral-05); } } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/datepicker/datepicker.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/datepicker/datepicker.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/datepicker/datepicker.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/datepicker/datepicker.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/datepicker/datepicker.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsDatepicker", "declaration": { "name": "GdsDatepicker", "module": "src/components/datepicker/datepicker.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/datepicker/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/datepicker/datepicker" } } ] }, { "kind": "javascript-module", "path": "src/components/details/details.component.ts", "declarations": [ { "kind": "class", "description": "Details component that provides collapsible content sections.", "name": "GdsDetails", "slots": [ { "description": "Default slot for details content", "name": "" } ], "members": [ { "kind": "field", "name": "summary", "type": { "text": "string" }, "default": "''", "description": "The summary text displayed in the details header", "attribute": "summary" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "description": "Group identifier for details behavior synchronization", "attribute": "name" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Controls the expanded state of the details", "attribute": "open", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "DetailsSize" }, "default": "'large'", "description": "Controls the size variant of the details", "attribute": "size" }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when details opens or closes", "name": "gds-ui-state" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "summary", "type": { "text": "string" }, "default": "''", "description": "The summary text displayed in the details header", "fieldName": "summary" }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "Group identifier for details behavior synchronization", "fieldName": "name" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Controls the expanded state of the details", "fieldName": "open" }, { "name": "size", "type": { "text": "DetailsSize" }, "default": "'large'", "description": "Controls the size variant of the details", "fieldName": "size" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-details", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsDetails", "declaration": { "name": "GdsDetails", "module": "src/components/details/details.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/details/details.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Details', component: 'gds-details', tags: ['autodocs'], argTypes: { summary: { description: 'The text displayed in the details header', control: 'text', table: { type: { summary: 'string' }, defaultValue: { summary: 'Summary' }, }, }, name: { description: 'Groups detailss together. Detailss with the same name will close each other when opened', control: 'text', table: { type: { summary: 'string' }, defaultValue: { summary: '' }, }, }, open: { description: 'Controls if the details is expanded', control: 'boolean', table: { type: { summary: 'boolean' }, }, }, size: { description: 'Controls the size of the details', control: { type: 'select', options: ['large', 'small'] }, table: { type: { summary: '\"large\" | \"small\"' }, defaultValue: { summary: 'large' }, }, }, }, }", "description": "The details component is a collapsible section that helps organize and hide content until needed.\n\nFeatures\n- Expandable/collapsible content sections with smooth animations\n- Group behavior: detailss with the same name will close each other automatically\n- Two size variants: large and small\n- Accessible by default\n- Keyboard navigation support" }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { summary: 'Click to expand', innerHTML: 'Details content goes here', }, }", "description": "Basic example of an details component." }, { "kind": "variable", "name": "Grouped", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Grouped', parameters: { docs: { description: { story: ` Detailss with the same name attribute will close each other when one is opened. In this example, all detailss are grouped together with the name attribute set to \"group-1\". \\`\\`\\`html ... \\`\\`\\` `, }, }, }, render: () => html` Heading Inside Details Linked content Heading Inside Details Linked content Heading Inside Details Linked content `, }", "description": "Example of grouped detailss." }, { "kind": "variable", "name": "Sizes", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Sizes', parameters: { docs: { description: { story: ` The details component supports two sizes: large(default) and small. \\`\\`\\`html ... \\`\\`\\` `, }, }, }, render: () => html` Large Size (Default) Content goes here Content goes here Content goes here Small Content goes here Content goes here Content goes here `, }", "description": "Example of different size variants." }, { "kind": "variable", "name": "RichContent", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Rich Content', parameters: { docs: { description: { story: 'Detailss can contain any type of content, including other components.', }, }, }, render: () => html`

Heading Inside Details

This is a paragraph with rich formatting.

  • List item 1
  • List item 2

Heading Inside Details

This is a paragraph with rich formatting.

  • List item 1
  • List item 2

Heading Inside Details

This is a paragraph with rich formatting.

  • List item 1
  • List item 2

Heading Inside Details

This is a paragraph with rich formatting.

  • List item 1
  • List item 2

Heading Inside Details

This is a paragraph with rich formatting.

  • List item 1
  • List item 2
 `, }", "description": "Example with rich content." }, { "kind": "variable", "name": "InitiallyOpen", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Initially Open', parameters: { docs: { description: { story: ` Detailss can be initially opened using the open attribute. \\`\\`\\`html ... \\`\\`\\` `, }, }, }, render: () => html` This details starts in the open state. `, }", "description": "Example of initially open details." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/details/details.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/details/details.stories.ts" } }, { "kind": "js", "name": "Grouped", "declaration": { "name": "Grouped", "module": "src/components/details/details.stories.ts" } }, { "kind": "js", "name": "Sizes", "declaration": { "name": "Sizes", "module": "src/components/details/details.stories.ts" } }, { "kind": "js", "name": "RichContent", "declaration": { "name": "RichContent", "module": "src/components/details/details.stories.ts" } }, { "kind": "js", "name": "InitiallyOpen", "declaration": { "name": "InitiallyOpen", "module": "src/components/details/details.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/details/details.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset; @layer base { .details { border-bottom: solid var(--gds-sys-space-5xs) var(--gds-sys-color-border-neutral-02); font: var(--gds-sys-text-body-m-regular); color: var(--gds-sys-color-content-neutral-01); transition: border-color 240ms linear; } .summary { display: flex; justify-content: space-between; align-items: center; list-style: none; user-select: none; outline-offset: var(--gds-sys-space-3xs); outline-color: currentColor; transition: all 120ms; color: var(--gds-sys-color-content-neutral-01); } .summary-icon { border-radius: var(--gds-sys-radius-max); background-color: transparent; transition: all 280ms; aspect-ratio: 1; width: max-content; height: max-content; line-height: 1; position: relative; } .summary-icon::after { content: ''; position: absolute; border-radius: var(--gds-sys-radius-max); transition: all 280ms; inset: 0; scale: 0.9; opacity: 0; pointer-events: none; } .summary:focus { outline-color: var(--gds-sys-color-content-neutral-01); &:not(:focus-visible) { outline-color: transparent; } } @media (pointer: fine) { .summary:hover .summary-icon::after, .summary:focus-visible .summary-icon::after { opacity: 1; scale: 1; } .summary:active .summary-icon::after { opacity: 1; scale: 1; } .details:hover, .details:focus-within { border-color: var(--gds-sys-color-border-neutral-04); } } .summary-label { font: var(--gds-sys-text-heading-xs); padding-block: var(--gds-sys-space-m); cursor: pointer; flex: 1; outline: none; } .details.small .summary-label { font: var(--gds-sys-text-heading-xs); padding-block: var(--gds-sys-space-s); } .details.small .content { font: var(--gds-sys-text-heading-xs); } .details:focus-visible { border-radius: var(--gds-sys-radius-2xs); } .details.open .content { padding-block-end: var(--gds-sys-space-l); } .details.small.open .content { padding-block-end: var(--gds-sys-space-s); } .content { interpolate-size: allow-keywords; height: 0; transition: height 0.35s ease, padding-block-end 0.35s ease; overflow: hidden; outline: none; scrollbar-width: none; } .content.open { overflow: auto; height: max-content; max-height: 100vh; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/details/details.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/details/details.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsDetails", "declaration": { "name": "GdsDetails", "module": "src/components/details/details.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/details/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/details/details" } } ] }, { "kind": "javascript-module", "path": "src/components/dialog/dialog.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsDialog", "slots": [ { "description": "The content of the dialog", "name": "" }, { "description": "The trigger button for the dialog", "name": "trigger" }, { "description": "The footer of the dialog", "name": "footer" }, { "description": "Complete override of the dialog content, including header and footer", "name": "dialog" } ], "members": [ { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "'dialog'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog is open. The state of the dialog can be controlled either\nby setting this property or by calling the `show()` and `close()` methods.\n\nWhen the state is explicitly changed by setting this prop, the state change cannot\nbe cancelled by events.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "heading", "type": { "text": "string | undefined" }, "description": "The dialog's heading.", "attribute": "heading" }, { "kind": "field", "name": "variant", "type": { "text": "'default' | 'slide-out'" }, "default": "'default'", "description": "The dialog's variant.", "attribute": "variant" }, { "kind": "field", "name": "placement", "type": { "text": "'initial' | 'top' | 'bottom' | 'left' | 'right'" }, "default": "'initial'", "description": "The dialog's placement.", "attribute": "placement" }, { "kind": "field", "name": "scrollable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the inner content of the dialog should have scrollable overflow. Scroll will appear if\nthe content exceeds the dialog's height, which can be controlled using the `height` property.\n\nThis property have no effect if the `dialog` slot is used. In that case, you need to add overflow\nstyles to the content inside the `dialog` slot.", "attribute": "scrollable" }, { "kind": "field", "name": "closedby", "type": { "text": "'closerequest' | 'none' | 'any'" }, "default": "'closerequest'", "description": "Controls which user actions can close the dialog. Maps to the native `` `closedby` attribute.\n\n- `closerequest` (default): The dialog can be dismissed by platform close gestures (Escape key, iOS swipe, etc.).\n The browser's anti-abuse mechanism applies: after one cancelled close request, subsequent cancellations\n require a user activation in between. This ensures the best mobile UX.\n- `none`: The dialog can only be closed by developer-specified mechanisms (buttons, click outside, or programmatic API).\n A manual Escape key listener is added for desktop users, with fully cancellable behavior (no anti-abuse limit).\n Mobile platform close gestures may not work in this mode.\n- `any`: The dialog can also be dismissed by light dismiss (clicking outside). Note that gds-dialog already\n handles click-outside via its own mechanism.", "attribute": "closedby", "reflects": true }, { "kind": "method", "name": "show", "parameters": [ { "name": "reason", "optional": true, "type": { "text": "string" } } ], "description": "Opens the dialog.\nThis is a programmatic API that always opens the dialog.\nEvents are dispatched for notification when a reason is provided, but cancellation is not honored." }, { "kind": "method", "name": "close", "parameters": [ { "name": "reason", "optional": true, "type": { "text": "string" }, "description": "The reason for closing the dialog." } ], "description": "Closes the dialog.\nThis is a programmatic API that always closes the dialog.\nEvents are dispatched for notification when a reason is provided, but cancellation is not honored." }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when the dialog is opened or closed. Can be cancelled to prevent the dialog from closing.", "name": "gds-ui-state" }, { "description": "Fired when the dialog is closed", "name": "gds-close" }, { "description": "Fired when the dialog is opened", "name": "gds-show" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog is open. The state of the dialog can be controlled either\nby setting this property or by calling the `show()` and `close()` methods.\n\nWhen the state is explicitly changed by setting this prop, the state change cannot\nbe cancelled by events.", "fieldName": "open" }, { "name": "heading", "type": { "text": "string | undefined" }, "description": "The dialog's heading.", "fieldName": "heading" }, { "name": "variant", "type": { "text": "'default' | 'slide-out'" }, "default": "'default'", "description": "The dialog's variant.", "fieldName": "variant" }, { "name": "placement", "type": { "text": "'initial' | 'top' | 'bottom' | 'left' | 'right'" }, "default": "'initial'", "description": "The dialog's placement.", "fieldName": "placement" }, { "name": "scrollable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the inner content of the dialog should have scrollable overflow. Scroll will appear if\nthe content exceeds the dialog's height, which can be controlled using the `height` property.\n\nThis property have no effect if the `dialog` slot is used. In that case, you need to add overflow\nstyles to the content inside the `dialog` slot.", "fieldName": "scrollable" }, { "name": "closedby", "type": { "text": "'closerequest' | 'none' | 'any'" }, "default": "'closerequest'", "description": "Controls which user actions can close the dialog. Maps to the native `` `closedby` attribute.\n\n- `closerequest` (default): The dialog can be dismissed by platform close gestures (Escape key, iOS swipe, etc.).\n The browser's anti-abuse mechanism applies: after one cancelled close request, subsequent cancellations\n require a user activation in between. This ensures the best mobile UX.\n- `none`: The dialog can only be closed by developer-specified mechanisms (buttons, click outside, or programmatic API).\n A manual Escape key listener is added for desktop users, with fully cancellable behavior (no anti-abuse limit).\n Mobile platform close gestures may not work in this mode.\n- `any`: The dialog can also be dismissed by light dismiss (clicking outside). Note that gds-dialog already\n handles click-outside via its own mechanism.", "fieldName": "closedby" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeYProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withPaddingProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-dialog", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsDialog", "declaration": { "name": "GdsDialog", "module": "src/components/dialog/dialog.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dialog/dialog.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Dialog', component: 'gds-dialog', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-dialog'), }, parameters: { layout: 'centered', }, }", "description": "A dialog appears in front of content to provide critical information or ask for a decision." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }", "description": "The easiest way to set up a dialog is to put a button in the trigger slot. This will\nautomatically open the dialog when the button is clicked." }, { "kind": "variable", "name": "SlideOut", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { ...DefaultParams.args, variant: 'slide-out', }, }", "description": "You can set the `variant` attribute to `slide-out` to make the dialog slide in from the right." }, { "kind": "variable", "name": "Scrollable", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { ...DefaultParams.args, height: '400px', scrollable: true, }, }", "description": "To enable scroll for overflowing content, you can set the `scrollable` property to `true`.\n\nThis only has an effect of the default content slot." }, { "kind": "variable", "name": "CustomButtons", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html`Open dialog This is the content of the dialog. Custom close button `, }", "description": "You can also open and close the dialog programmatically by calling the `show()` and `close()` methods.\nIn this case you should add `aria-haspopup=\"dialog\"` to the trigger element. Slotted triggers will get\nthis attribute automatically.\n\nInside the dialog, you can use the `slot=\"footer\"` to add buttons to the footer of the dialog." }, { "kind": "variable", "name": "Events", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html` Open dialog This is the content of the dialog. Custom btn Custom btn 2 `, }", "description": "You can listen to the `gds-show`, `gds-close` and `gds-ui-state` events to know when the dialog is opened or closed.\n\nWhen `close()` or `show()` is called without a parameter, the event will not be emitted. If a parameter is passed, the\nevent will be emitted with the parameter as the event detail. Also when any of the built-in methods are used to open or\nclose the dialog, the event will be emitted with the parameter as the event detail.\n\nAll the emitted events will have a `detail` object with a reason property that can be used to determine the reason for the event.\n\nPossible reasons are:\n- `btn-close`: The dialog was closed by the user clicking the close button.\n- `btn-cancel`: The dialog was closed by the user clicking the default cancel button.\n- `btn-ok`: The dialog was closed by the user clicking the default OK button.\n- `native-close`: The dialog was closed by the user pressing the Escape key.\n- `click-outside`: The dialog was closed by the user clicking outside the dialog.\n- `slotted-trigger`: The dialog was opened by the user clicking the slotted trigger button.\n\nThe reason can also be a custom string supplied when calling the `close()` or `show()` methods.\n\n### Preventing close\nThe `gds-ui-state` event can be cancelled by calling `preventDefault()` on the event to prevent the dialog from closing.\nWhen using built-in triggers (buttons, Escape, click outside, trigger slot), cancelling `gds-ui-state` fully prevents the action.\nWhen calling `close()` or `show()` programmatically, events are dispatched for notification but cancellation does not prevent the state change." }, { "kind": "variable", "name": "CustomDialog", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html` Open dialog This is the content of the dialog.
If you put stuff here, you can customize the entire dialog, including header and footer.
`, }", "description": "You can customize the dialog completely by putting content in the `dialog` slot.\nThis will replace the default content of the dialog, including the header and footer.\n\nWhen this slot is used, the footer slot will not be rendered, so you need to add a custom footer manually.\n\n**Important:** Make sure to still use the `heading` property, as it is used to give the dialog an accessible name." }, { "kind": "variable", "name": "CancelableClose", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html` { const detail = (e as CustomEvent).detail // Only gate close attempts, not open if (detail.open) { const checkbox = document .getElementById('my-dialog-cancel') ?.querySelector('#agree-checkbox') as HTMLInputElement | null if (!checkbox?.checked) { e.preventDefault() } } }} > Open dialog

You must agree to the terms before closing this dialog. Try pressing Escape, clicking outside, or using the close button — the dialog will stay open until the checkbox is checked.

`, }", "description": "You can prevent the dialog from closing by cancelling the `gds-ui-state` event.\n\nIn this example, the dialog contains a checkbox that must be checked before the dialog can be closed.\nAny built-in close trigger (close button, Escape, click outside) is blocked until the condition is met.\n\nNote the use of `closedby=\"none\"` — this disables the browser's native close request handling (including\nthe anti-abuse mechanism that would force-close the dialog on repeated Escape presses). With `closedby=\"none\"`,\nthe component adds its own Escape key listener so desktop users can still close via keyboard, and cancellation\nis always honored. Mobile platform close gestures (e.g. iOS swipe) will not work in this mode." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/dialog/dialog.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/dialog/dialog.stories.ts" } }, { "kind": "js", "name": "SlideOut", "declaration": { "name": "SlideOut", "module": "src/components/dialog/dialog.stories.ts" } }, { "kind": "js", "name": "Scrollable", "declaration": { "name": "Scrollable", "module": "src/components/dialog/dialog.stories.ts" } }, { "kind": "js", "name": "CustomButtons", "declaration": { "name": "CustomButtons", "module": "src/components/dialog/dialog.stories.ts" } }, { "kind": "js", "name": "Events", "declaration": { "name": "Events", "module": "src/components/dialog/dialog.stories.ts" } }, { "kind": "js", "name": "CustomDialog", "declaration": { "name": "CustomDialog", "module": "src/components/dialog/dialog.stories.ts" } }, { "kind": "js", "name": "CancelableClose", "declaration": { "name": "CancelableClose", "module": "src/components/dialog/dialog.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dialog/dialog.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset, transitional-styles; @layer base { :host { display: contents; --_margin: var(--gds-sys-space-l); } dialog { transition: transform var(--gds-sys-motion-duration-fast) cubic-bezier(var(--gds-sys-motion-easing-ease-out)); background: transparent; padding: 0; border-width: 0; overflow: visible; max-width: calc(100vw - var(--_margin)); max-height: 100vh; display: flex; width: 400px; @starting-style { opacity: 0; transform: translateY(-16px); &::backdrop { opacity: 0; } } &::backdrop { transition: all var(--gds-sys-motion-duration-fast) cubic-bezier(var(--gds-sys-motion-easing-ease-out)); background: rgba(100, 100, 100, 0.4); } } dialog > * { flex-grow: 1; } dialog.default.placement-initial { margin: auto; --_margin: 0px; } dialog.default.placement-top { margin: var(--gds-sys-space-l) auto auto; } dialog.default.placement-bottom { margin: auto auto var(--gds-sys-space-l) auto; } dialog.default.placement-left { margin: auto var(--gds-sys-space-l) auto auto; } dialog.default.placement-right { margin: auto auto auto var(--gds-sys-space-l); } dialog.slide-out { --_in: var(--gds-sys-space-m); --_margin: var(--gds-sys-space-l); height: auto; &.placement-initial, &.placement-right { inset: var(--_in); @media (min-width: 648px) { --_in: var(--gds-sys-space-l); inset: var(--_in) var(--_in) var(--_in) auto; } @starting-style { transform: translateX(var(--gds-sys-space-6xl)); } } &.placement-left { @starting-style { transform: translateX(calc(-1 * var(--gds-sys-space-6xl))); } inset: var(--_in); @media (min-width: 648px) { --_in: var(--gds-sys-space-l); inset: var(--_in) auto var(--_in) var(--_in); } } &.placement-top { @starting-style { transform: translateY(calc(-1 * var(--gds-sys-space-6xl))); } inset: var(--_in) var(--_in) auto var(--_in); } &.placement-bottom { @starting-style { transform: translateY(calc(var(--gds-sys-space-6xl))); } inset: auto var(--_in) var(--_in) var(--_in); } } dialog:focus { outline: none; } .card { flex-direction: column; } slot[name='footer'] > *, slot[name='footer']::slotted(*) { flex: 1; } h2 { margin: 0; padding: 0; font: var(--gds-sys-text-heading-s); margin-block-start: var(--gds-sys-space-4xs); } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/dialog/dialog.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dialog/dialog.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsDialog", "declaration": { "name": "GdsDialog", "module": "src/components/dialog/dialog.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dialog/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/dialog/dialog" } } ] }, { "kind": "javascript-module", "path": "src/components/dialog/scroll-lock.ts", "declarations": [ { "kind": "function", "name": "registerGlobalScrollLockStyles" }, { "kind": "function", "name": "lockBodyScrolling", "parameters": [ { "name": "lockingEl", "type": { "text": "HTMLElement" } } ], "description": "Prevents body scrolling. Keeps track of which elements requested a lock so multiple levels of locking are possible\nwithout premature unlocking." }, { "kind": "function", "name": "unlockBodyScrolling", "parameters": [ { "name": "lockingEl", "type": { "text": "HTMLElement" } } ], "description": "Unlocks body scrolling. Scrolling will only be unlocked once all elements that requested a lock call this method." } ], "exports": [ { "kind": "js", "name": "registerGlobalScrollLockStyles", "declaration": { "name": "registerGlobalScrollLockStyles", "module": "src/components/dialog/scroll-lock.ts" } }, { "kind": "js", "name": "lockBodyScrolling", "declaration": { "name": "lockBodyScrolling", "module": "src/components/dialog/scroll-lock.ts" } }, { "kind": "js", "name": "unlockBodyScrolling", "declaration": { "name": "unlockBodyScrolling", "module": "src/components/dialog/scroll-lock.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/div/div.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsDiv", "members": [ { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level" }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system." }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values." }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values." }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values." }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values." }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values." }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeYProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withPaddingProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withPositioningProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-div", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsDiv", "declaration": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/div/div.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Div', component: 'gds-div', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-div'), }, }", "description": "\n`gds-div` is a base element in the declarative layout system.\n\nDiv accepts all available style expression properties, and is also the base class for `gds-flex`, `gds-grid`, `gds-card` and `gds-text`" }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { background: '01', border: '2xs', 'border-radius': 'm', 'border-color': 'neutral-02', width: '4xl', height: '4xl', }, }" }, { "kind": "variable", "name": "Example", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` `, }", "description": "Here is an example of a simple layout structure using `gds-div`:" }, { "kind": "variable", "name": "CardBorder", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Border Style', render: (args) => html` Top Right Bottom Left All `, }", "description": "Border styling follows the same patterns as CSS and can be controlled using the shorthand properties `border`, `border-width`, `border-style`, `border-color`\n\n- `border-color` defaults to subtle-01\n- `border-width` defaults to 0 (supports all spacing tokens)\n- `border-style` defaults to solid\n\nTo add a 1px primary border around the element:\n\n```html\n\n```\n\nTo only add border bottom:\n\n```html\n\n```\n\nTo add a 1px secodary color border on the bottom:\n\n```html\n\n```" }, { "kind": "variable", "name": "BorderRadius", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { background: 'neutral-02', border: '2xs', 'border-radius': 'm', 'border-color': 'strong', width: '8xl', height: '4xl', }, }", "description": "\nValues are mapped directly from our radius tokens to maintain proportional scaling.
\nView all available radius tokens and their values in Green Studio:\nhttps://seb.io/studio/radius\n\n\n##### Single value\n```html\n...\n```\n\n##### Multiple corners / (top-left, top-right, bottom-right, bottom-left)\n```html\n...\n```" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/div/div.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/div/div.stories.ts" } }, { "kind": "js", "name": "Example", "declaration": { "name": "Example", "module": "src/components/div/div.stories.ts" } }, { "kind": "js", "name": "CardBorder", "declaration": { "name": "CardBorder", "module": "src/components/div/div.stories.ts" } }, { "kind": "js", "name": "BorderRadius", "declaration": { "name": "BorderRadius", "module": "src/components/div/div.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/div/div.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { display: block; box-sizing: border-box; border-style: solid; border-width: 0; border-color: var(--gds-sys-color-border-neutral-02); } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/div/div.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/div/div.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsDiv", "declaration": { "name": "GdsDiv", "module": "src/components/div/div.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/div/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/div/div" } } ] }, { "kind": "javascript-module", "path": "src/components/divider/divider.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsDivider", "members": [ { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Controls the color property of the divider.\nSupports all the color tokens from the design system.\n\nYou can apply color like this:\n\n```html\n\n```", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "Controls the size property of the divider.\nSupports all the space tokens from the design system.\n\nYou can apply size like this:\n\n```html\n\n```\n\nThe above example will apply the size style of 2xl." }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Controls the opacity property of the divider.\nSupports all the opacity tokens from the design system.\n\nYou can apply opacity like this:\n\n```html\n\n```\nThe above example will apply the opacity style of base400.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "role", "type": { "text": "string | null" }, "default": "null", "description": "Use the role attribute primarily if you only want the divider to be a visual element.\n\n```html\n\n\n```", "attribute": "role" }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "role", "type": { "text": "string | null" }, "default": "null", "description": "Use the role attribute primarily if you only want the divider to be a visual element.\n\n```html\n\n\n```", "fieldName": "role" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-divider", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsDivider", "declaration": { "name": "GdsDivider", "module": "src/components/divider/divider.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/divider/divider.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Divider', component: 'gds-divider', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-divider'), }, }", "description": "Divider creates visual and semantic separation between content.\n\nAdd `role=\"presentation\"` to the divider if you only want a visual separation.\n\nThe divider can be customized with different properties like color and size.\n\n\n> Divider should not be used as a border for a container. In that case, use the border property of the container instead." }, { "kind": "variable", "name": "Divider", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Divider', render: (args) => html` `, }" }, { "kind": "variable", "name": "Color", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Color', render: (args) => html` neutral-01 neutral-02 neutral-03 neutral-04 neutral-05 information-01 information-02 positive-01 positive-02 negative-01 negative-02 warning-01 warning-02 notice-01 notice-02 `, }", "description": "The `gds-divider` accepts all the border tokens as color value.\n\nExample:\n\n```html\n\n\n```" }, { "kind": "variable", "name": "Opacity", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Opacity', render: (args) => html` Opacity: 0.6 Opacity: 0.3 Opacity: 0.2 `, }", "description": "In addition to the color and size properties, the divider component also supports the opacity property.\n\nExample:\n\n```html\n\n\n\n\n```" }, { "kind": "variable", "name": "Size", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Size', render: (args) => html` Size: 2xl Size: 4xl Size: 6xl `, }", "description": "The `gds-divider` with different sizes\n\nExample:\n\n```html\n\n\n\n\n```\n\nIt accepts all the [size tokens from the design system](?path=/docs/style-size--docs).\n\n> The size property doesn't affect the size of the border itself but the space around the divider." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/divider/divider.stories.ts" } }, { "kind": "js", "name": "Divider", "declaration": { "name": "Divider", "module": "src/components/divider/divider.stories.ts" } }, { "kind": "js", "name": "Color", "declaration": { "name": "Color", "module": "src/components/divider/divider.stories.ts" } }, { "kind": "js", "name": "Opacity", "declaration": { "name": "Opacity", "module": "src/components/divider/divider.stories.ts" } }, { "kind": "js", "name": "Size", "declaration": { "name": "Size", "module": "src/components/divider/divider.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/divider/divider.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { display: flex; align-items: center; width: 100%; height: var(--_size); } hr { width: 100%; height: 1px; min-height: 1px; max-height: 1px; border: 0; margin: 0; padding: 0; background: var(--_color, currentColor); box-sizing: border-box; } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/divider/divider.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/divider/divider.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsDivider", "declaration": { "name": "GdsDivider", "module": "src/components/divider/divider.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/divider/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/divider/divider" } } ] }, { "kind": "javascript-module", "path": "src/components/dropdown/dropdown.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsDropdown", "slots": [ { "description": "Options for the dropdown. Accepts `gds-option` and `gds-menu-heading` elements.", "name": "" }, { "description": "Custom content for the trigger button can be assigned through this slot.", "name": "trigger" }, { "description": "A longer supporting text can be placed here. It will be displayed in a panel when the user clicks the info button.", "name": "extended-supporting-text" }, { "description": "***(deprecated - use `errorMessage` property instead)*** Error message to show below the input field whem there is a validation error.", "name": "message" }, { "description": "***(deprecated - use `supporting-text` property instead)*** Renders between the label and the trigger button.", "name": "sub-label" } ], "events": [ { "description": "Fired when the value of the dropdown is changed through user interaction (not when value prop is set programatically).", "name": "change" }, { "description": "Fired when the value of the dropdown is changed through user interaction.", "name": "input" }, { "description": "Fired when the dropdown is opened or closed by the user. Can be cancelled to prevent the dropdown from opening or closing.", "name": "gds-ui-state" }, { "description": "Fired when the user types in the search field. The event is cancellable, and the consumer is expected to handle filtering and updating the options list if the event is cancelled.", "name": "gds-filter-input" }, { "description": "Fired when the user clears the input using the clear button.", "name": "gds-input-cleared" }, { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" }, "tagName": "gds-dropdown", "customElement": true, "subcomponents": [ { "tagName": "gds-option", "description": "Defines an option in the dropdown" }, { "tagName": "gds-menu-heading", "description": "Defines a non-selectable heading in the dropdown options list" } ], "members": [ { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "type", "readonly": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "supportingText", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field itself.", "attribute": "supporting-text", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Sets the open state of the dropdown.", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "searchable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dropdown should be searchable.", "attribute": "searchable", "reflects": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dropdown should support multiple selections.\nWhen set to true, the dropdown will render a checkbox next to each option.\nThe value of the dropdown will be an array of the selected values.", "attribute": "multiple", "reflects": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dropdown should be clearable.", "attribute": "clearable", "reflects": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "combobox", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dropdown should be rendered as a combobox.\nWhen set to true, the dropdown will render an input field instead of a button.\nThe value of the dropdown will be a string representing the selected value.", "attribute": "combobox", "reflects": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "compareWith", "type": { "text": "(a: unknown, b: unknown) => boolean" }, "description": "Delegate function for comparing option values.\nBy default the option values are compared using strict equality.\nIf you want to compare objects by field values, you can provide\na custom compare function here. The function should return true\nif the values are considered equal.\n\nExample:\n```ts\ndropdown.compareWith = (a, b) => a.id === b.id\n```", "attribute": "compareWith", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "searchFilter", "type": { "text": "(q: string, o: GdsOption) => boolean" }, "description": "Delegate function for customizing the search filtering.\nBy default, the search filter will just check if the option label\ncontains the search string using [String.includes](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/includes).\n\nThis property allows you to provide a custom filter function to use instead.\n\nFor example, to filter on value instead of label:\n```ts\ndropdown.searchFilter = (query, option) =>\n option.value.toLowerCase().includes(query.toLowerCase())\n```", "attribute": "searchFilter", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "syncPopoverWidth", "type": { "text": "boolean" }, "default": "false", "description": "Whether the popover should sync its width to the trigger button. When this is\nset to `true`, the popover will always have the same width as the trigger button.\n\nBy default, line-breaks will be applied to the option content if it is wider than\nthe popover width. If you use this option, make sure to verify that your options\nare still readable and apply appropriate custom layout or truncation if neccecary.", "attribute": "sync-popover-width", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "maxHeight", "type": { "text": "number" }, "default": "500", "description": "Maximum height of the dropdown list.", "attribute": "max-height", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "size", "type": { "text": "'medium' | 'small'" }, "default": "'medium'", "description": "Size of the dropdown. Supports `medium` and `small`. There is no `large` size for dropdowns.\n`medium` is the default size.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "hideLabel", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the label.", "deprecated": "- use `plain` instead", "attribute": "hide-label", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Hides the header and the footer, while still keeping the accessible label\n\nAlways set the `label` attribute, and if you need to hide it, add this attribute and keep `label` set.", "attribute": "plain", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "disableMobileStyles", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable the mobile styles.", "attribute": "disableMobileStyles", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "showExtendedSupportingText", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "attribute": "show-extended-supporting-text", "reflects": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "options", "description": "Get the options of the dropdown.", "readonly": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "placeholder", "description": "Return the first option with a isPlaceholder attribute.\nIf no placeholder is found, this will be undefined.", "readonly": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "displayValue", "description": "Returns the display value as a string.\nIf the dropdown is in multiple mode, this will be a comma separated list of the selected values.", "readonly": true, "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "method", "name": "focus", "description": "Moves focus to this element.", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "method", "name": "test_getFieldElement", "description": "A reference to the field element. This does not refer to the trigger button element itself,\nbut the wrapper that makes up the visual field.\nIntended for use in integration tests.", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "value", "description": "Get or set the value of the form control.", "attribute": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "supporting-text", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field itself.", "fieldName": "supportingText", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Sets the open state of the dropdown.", "fieldName": "open", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "searchable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dropdown should be searchable.", "fieldName": "searchable", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dropdown should support multiple selections.\nWhen set to true, the dropdown will render a checkbox next to each option.\nThe value of the dropdown will be an array of the selected values.", "fieldName": "multiple", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dropdown should be clearable.", "fieldName": "clearable", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "combobox", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dropdown should be rendered as a combobox.\nWhen set to true, the dropdown will render an input field instead of a button.\nThe value of the dropdown will be a string representing the selected value.", "fieldName": "combobox", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "compareWith", "type": { "text": "(a: unknown, b: unknown) => boolean" }, "description": "Delegate function for comparing option values.\nBy default the option values are compared using strict equality.\nIf you want to compare objects by field values, you can provide\na custom compare function here. The function should return true\nif the values are considered equal.\n\nExample:\n```ts\ndropdown.compareWith = (a, b) => a.id === b.id\n```", "fieldName": "compareWith", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "searchFilter", "type": { "text": "(q: string, o: GdsOption) => boolean" }, "description": "Delegate function for customizing the search filtering.\nBy default, the search filter will just check if the option label\ncontains the search string using [String.includes](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/includes).\n\nThis property allows you to provide a custom filter function to use instead.\n\nFor example, to filter on value instead of label:\n```ts\ndropdown.searchFilter = (query, option) =>\n option.value.toLowerCase().includes(query.toLowerCase())\n```", "fieldName": "searchFilter", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "sync-popover-width", "type": { "text": "boolean" }, "default": "false", "description": "Whether the popover should sync its width to the trigger button. When this is\nset to `true`, the popover will always have the same width as the trigger button.\n\nBy default, line-breaks will be applied to the option content if it is wider than\nthe popover width. If you use this option, make sure to verify that your options\nare still readable and apply appropriate custom layout or truncation if neccecary.", "fieldName": "syncPopoverWidth", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "max-height", "type": { "text": "number" }, "default": "500", "description": "Maximum height of the dropdown list.", "fieldName": "maxHeight", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "size", "type": { "text": "'medium' | 'small'" }, "default": "'medium'", "description": "Size of the dropdown. Supports `medium` and `small`. There is no `large` size for dropdowns.\n`medium` is the default size.", "fieldName": "size", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "hide-label", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the label.", "deprecated": "- use `plain` instead", "fieldName": "hideLabel", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Hides the header and the footer, while still keeping the accessible label\n\nAlways set the `label` attribute, and if you need to hide it, add this attribute and keep `label` set.", "fieldName": "plain", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "disableMobileStyles", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable the mobile styles.", "fieldName": "disableMobileStyles", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "show-extended-supporting-text", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "fieldName": "showExtendedSupportingText", "inheritedFrom": { "name": "Dropdown", "module": "src/components/dropdown/dropdown.component.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "fieldName": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "value", "description": "Get or set the value of the form control.", "fieldName": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/listbox/option.component" } }, { "kind": "js", "name": "GdsDropdown", "declaration": { "name": "GdsDropdown", "module": "src/components/dropdown/dropdown.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dropdown/dropdown.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Dropdown', component: 'gds-dropdown', subcomponents: { GdsOption: 'gds-option' }, parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-dropdown'), }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/dropdown)\n | \n[Usage guidelines](https://designlibrary.sebgroup.com/components/component-dropdown)\n\nA dropdown enables the user to choose one or multiple options from a list.\n\nThe dropdown can be searchable, allowing users to filter the options by typing in the input\nfield, and it also supports both single and multiple selection." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "OptionHeadings", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Space vehicles Enterprise 1701-D Millenium Falcon Defiant Voyager Prometheus Discovery Columbia Yamato Equinox Daedalus Ground vehicles AT-AT AT-ST AT-TE AT-RT AT-AP
Selected starship:
`, }", "description": "`` can be used to create group headings in the dropdown." }, { "kind": "variable", "name": "CustomTrigger", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Custom trigger content', render: (args) => { const optionTemplate = (slot?: string) => html` Account 123 456 Balance 9 654,00 ` return html` ${optionTemplate('trigger')} ${optionTemplate()} ${optionTemplate()} ${optionTemplate()} ` }, }", "description": "Custom content for the trigger can be provided by assigning an element to the `trigger` slot. When this slot is occupied,\nthe default trigger content will be overridden, and you will have to manage the displayed value yourself." }, { "kind": "variable", "name": "SyncedPopoverWidth", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Synced popover width', render: (args) => html` Enterprise 1701-D is a starship from the TNG series Millenium Falcon Defiant Voyager Prometheus Discovery Columbia `, }", "description": "Normally, the popover will never be narrower than the trigger, but may be wider if the option contents are wider.\nOptionally, the width of the popover can be locked to the width of the trigger by setting the `sync-popover-width` attribute." }, { "kind": "variable", "name": "Size", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` Select tech Warp Drive Cybernetics Nanotechnology Cloning Cryonics Teleportation `, }", "description": "The Dropdown is available in two sizes: `small` and `medium`. `medium` is the default." }, { "kind": "variable", "name": "HiddenLabel", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` Select tech Warp Drive Cybernetics Nanotechnology Cloning Cryonics Teleportation `, }", "description": "A common use case for the small version is in constrained areas, such as table cells. In those cases,\nit is also often desirable to hide the label. This can be done with the `hide-label` attribute.\n\nOmitting the label attribute itself is not recommended, as it would make the dropdown inaccessible to\nscreen readers." }, { "kind": "variable", "name": "PlaceholderOptions", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` This is a placeholder Warp Drive Cybernetics Nanotechnology Cloning Cryonics Teleportation `, }", "description": "If you need to show a placeholder in the trigger before an option is selected, but you don't want\nit to show in the list of options, you can mark an option as a placeholder by setting its\n`isplaceholder` attribute." }, { "kind": "variable", "name": "Clearable", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` None Warp Drive Cybernetics Nanotechnology Cloning Cryonics Teleportation `, }", "description": "To make it easy for users to clear a field, an x-icon button can be placed at the end of the field. This is commonly used in search/filter forms." }, { "kind": "variable", "name": "Searchable", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` This is a placeholder Warp Drive Cybernetics Nanotechnology Cloning Cryonics Teleportation Artificial Intelligence Robotics Quantum Computing Biotechnology Genetic Engineering Holography Fusion Power Antimatter Dark Matter Neural Interfaces Exoskeletons Space Elevators Terraforming Nanobots Smart Materials Augmented Reality Virtual Reality Brain-Computer Interface Cybersecurity Biometrics `, }", "description": "In order to show a search field on the dropdown, set the `searchable` attribute." }, { "kind": "variable", "name": "Multiple", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` This is a placeholder Warp Drive Cybernetics Nanotechnology Cloning Cryonics Teleportation `, }", "description": "Use the `multiple` attribute to allow multiple selections. The selected values will be displayed" }, { "kind": "variable", "name": "Combobox", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` Warp Drive Cybernetics Nanotechnology Cloning Cryonics Teleportation Artificial Intelligence Robotics Quantum Computing Biotechnology Genetic Engineering Holography Fusion Power Antimatter Dark Matter Neural Interfaces Exoskeletons Space Elevators Terraforming Nanobots Smart Materials Augmented Reality Virtual Reality Brain-Computer Interface Cybersecurity Biometrics `, }", "description": "The dropdown supports the combobox pattern with the `combobox` attribute.\n\nUse combobox when the user needs to have the option of entering a custom value but is also helped by a list of predefined options.\n\nDon't use combobox if you only need a searchable dropdown but don't want to allow custom values. Use the `searchable` attribute instead in that case.\n\n***Note:***\n- The `combobox` attribute doesn't work with the `multiple` attribute. If both are used, the `combobox` attribute will be ignored.\n- Custom trigger content will not be rendered when the `combobox` attribute is used, since it will be replaced with an input element internally.\n- Never combine the `searchable` attribute with the `combobox` attribute, since the combobox input is already used for filtering.\n- For practical reasons, mobile styles are disabled when the `combobox` attribute is used." }, { "kind": "variable", "name": "Validation", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html` e.target.reportValidity()} .validator=${{ validate: (el: any) => { if (!el.value) { return [ { ...el.validity, valid: false, customError: true, }, 'Please select a technology', ] } if (el.value === 'warp') { return [ { ...el.validity, valid: false, customError: true, }, 'Warp drive is not yet available', ] } }, }} > Select a technology Warp Drive Cybernetics Nanotechnology Cloning Cryonics Teleportation `, }" }, { "kind": "variable", "name": "Disabled", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` This is a placeholder Warp Drive Cybernetics Nanotechnology Cloning Cryonics Teleportation `, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "OptionHeadings", "declaration": { "name": "OptionHeadings", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "CustomTrigger", "declaration": { "name": "CustomTrigger", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "SyncedPopoverWidth", "declaration": { "name": "SyncedPopoverWidth", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "Size", "declaration": { "name": "Size", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "HiddenLabel", "declaration": { "name": "HiddenLabel", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "PlaceholderOptions", "declaration": { "name": "PlaceholderOptions", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "Clearable", "declaration": { "name": "Clearable", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "Searchable", "declaration": { "name": "Searchable", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "Multiple", "declaration": { "name": "Multiple", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "Combobox", "declaration": { "name": "Combobox", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "Validation", "declaration": { "name": "Validation", "module": "src/components/dropdown/dropdown.stories.ts" } }, { "kind": "js", "name": "Disabled", "declaration": { "name": "Disabled", "module": "src/components/dropdown/dropdown.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dropdown/dropdown.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset; @layer base { :host { isolation: auto; contain: none; } #field::part(_base) { cursor: pointer; block-size: auto; } #clear-btn { margin-top: calc(-1 * var(--gds-sys-space-xs)); margin-bottom: calc(-1 * var(--gds-sys-space-xs)); } button#trigger { flex: 0 1 100%; cursor: pointer; /* This prevents overflow when the text is too long */ display: grid; } #trigger:focus { outline: none; } slot[name='trigger'] > span { display: block; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; } input[type='text'] { border-radius: var(--gds-sys-radius-xs); border-bottom-left-radius: 0; border-bottom-right-radius: 0; font-size: inherit; line-height: inherit; border: none; outline: none; color: var(--gds-sys-color-content-disabled-01); border-color: var(--gds-sys-color-border-neutral-01); border-width: 0 0 var(--gds-sys-space-5xs) 0; border-style: solid; width: 100%; padding: var(--gds-sys-space-m); font-weight: var(--gds-sys-text-weight-regular); flex: 1; box-sizing: border-box; font-family: inherit; &:focus { border-color: var(--gds-sys-color-border-neutral-01); color: var(--gds-sys-color-content-neutral-01); } &::placeholder { font-family: inherit; font-weight: var(--gds-sys-text-weight-book); color: var(--gds-sys-color-content-disabled-01); } } [aria-expanded='true'] [slot='trail'] { transform: scaleY(-1); } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/dropdown/dropdown.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dropdown/dropdown.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/dropdown/dropdown.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/dropdown/dropdown.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dropdown/dropdown.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsDropdown", "declaration": { "name": "GdsDropdown", "module": "src/components/dropdown/dropdown.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dropdown/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/dropdown/dropdown" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/listbox/option" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/primitives/menu/menu-heading" } } ] }, { "kind": "javascript-module", "path": "src/components/fab/fab.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsFab", "slots": [ { "description": "Content of the FAB", "name": "", "inheritedFrom": { "name": "GdsButton", "module": "src/components/button/button.component.ts" } }, { "description": "An optional slot that allows a `gds-icon-[ICON_NAME]` element to be placed before the label.", "name": "lead", "inheritedFrom": { "name": "GdsButton", "module": "src/components/button/button.component.ts" } }, { "description": "An optional slot that allows a `gds-icon-[ICON_NAME]` element to be placed after the label.", "name": "trail", "inheritedFrom": { "name": "GdsButton", "module": "src/components/button/button.component.ts" } } ], "mixins": [ { "name": "withPositioningProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsButton", "module": "/src/components/button/button.component" }, "tagName": "gds-fab", "customElement": true, "members": [ { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the button is disabled.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Spread the contents of the button", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "type", "type": { "text": "HTMLButtonElement['type'] | undefined" }, "description": "The type of the button.", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "rank", "type": { "text": "'primary' | 'secondary' | 'tertiary'" }, "default": "'primary'", "description": "The rank of the button. Defaults to \"primary\".", "attribute": "rank", "reflects": true, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "variant", "type": { "text": "| 'brand'\n | 'neutral'\n | 'positive'\n | 'negative'\n | 'notice'\n | 'warning'" }, "default": "'neutral'", "description": "Defines which variant the button belongs to. Defaults to \"neutral\".", "attribute": "variant", "reflects": true, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "size", "type": { "text": "'xs' | 'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "Sets the size of the button. Defaults to \"medium\".", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the button. Use this to add an accessible label to the button when no text is provided in the default slot.", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "wrapped", "type": { "text": "boolean" }, "default": "false", "description": "When set, adds a wrapped class to the button.", "attribute": "wrapped", "reflects": true, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "When set, the underlying button will be rendered as an anchor element.", "attribute": "href", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Where to display the linked URL. Only used when href is present.", "attribute": "target", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked URL as space-separated link types. Only used when href is present. Defaults to \"noreferrer noopener\" for security reasons when target is set.", "attribute": "rel", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "description": "Causes the browser to treat the linked URL as a download. Can be used with or without a filename value. Only used when href is present.", "attribute": "download", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "method", "name": "click", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "value", "description": "Get or set the value of the form control.", "attribute": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the button is disabled.", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "type", "type": { "text": "HTMLButtonElement['type'] | undefined" }, "description": "The type of the button.", "fieldName": "type", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "rank", "type": { "text": "'primary' | 'secondary' | 'tertiary'" }, "default": "'primary'", "description": "The rank of the button. Defaults to \"primary\".", "fieldName": "rank", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "variant", "type": { "text": "| 'brand'\n | 'neutral'\n | 'positive'\n | 'negative'\n | 'notice'\n | 'warning'" }, "default": "'neutral'", "description": "Defines which variant the button belongs to. Defaults to \"neutral\".", "fieldName": "variant", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "size", "type": { "text": "'xs' | 'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "Sets the size of the button. Defaults to \"medium\".", "fieldName": "size", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the button. Use this to add an accessible label to the button when no text is provided in the default slot.", "fieldName": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "wrapped", "type": { "text": "boolean" }, "default": "false", "description": "When set, adds a wrapped class to the button.", "fieldName": "wrapped", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "href", "type": { "text": "string" }, "default": "''", "description": "When set, the underlying button will be rendered as an anchor element.", "fieldName": "href", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Where to display the linked URL. Only used when href is present.", "fieldName": "target", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked URL as space-separated link types. Only used when href is present. Defaults to \"noreferrer noopener\" for security reasons when target is set.", "fieldName": "rel", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Causes the browser to treat the linked URL as a download. Can be used with or without a filename value. Only used when href is present.", "fieldName": "download", "inheritedFrom": { "name": "Button", "module": "src/components/button/button.component.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "value", "description": "Get or set the value of the form control.", "fieldName": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when the button is clicked.", "name": "click", "inheritedFrom": { "name": "GdsButton", "module": "src/components/button/button.component.ts" } }, { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFab", "declaration": { "name": "GdsFab", "module": "src/components/fab/fab.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/fab/fab.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/FAB', component: 'gds-fab', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-fab'), }, }", "description": "Floating action button persists across screens for constant access to features that needs to be accessible at all times.\n\nThe button is always floating visible in the users viewport, typically in the lower right\ncorner. This button can be used with an icon only." }, { "kind": "variable", "name": "Usage", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "RanksAndVariants", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Signal ', parameters: { ...DefaultParams.parameters, controls: { include: [] }, }, render: (args) => html` Primary Secondary Tertiary Primary Secondary Tertiary Primary Secondary Tertiary `, }", "description": "The FAB can be used with a signal to indicate that there is something new or updated.\n\nSignal style matches the button rank and variant." }, { "kind": "variable", "name": "IconButton", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Icon Button', parameters: { ...DefaultParams.parameters, controls: { include: [] }, }, render: (args) => html` `, }", "description": "The FAB can be used with all the `gds-button` properties." }, { "kind": "variable", "name": "Color", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Color', parameters: { ...DefaultParams.parameters, controls: { include: [] }, }, render: (args) => html` Secondary `, }", "description": "Default color of the signal within the FAB is the same as the button color.\n\nIf you want to change the color of the signal, you can use the `color` property." }, { "kind": "variable", "name": "Position", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Position', parameters: { ...DefaultParams.parameters, controls: { include: [] }, }, render: (args) => html` I'm a FAB `, }", "description": "You can position the FAB using the `inset` property.\nIt takes all the default CSS inset values.\n\ne.g\n\n```html\n\n I'm a FAB\n\n```\n\nAnd also the `position` property can be set to use any valid CSS position values.\n\ne.g\n\n```html\n\n Absolute Position\n\n```" }, { "kind": "variable", "name": "ZIndex", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'z-index', parameters: { ...DefaultParams.parameters, controls: { include: [] }, }, render: (args) => html` Show above other things Title example Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Click me! Title example Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Click me! `, }", "description": "The z order of the FAB is set by default to `1050`.\n\nThis is recommended to keep the FAB above other elements.\n\nIf you want to change the z-index, that should be done in the CSS or wrap FAB in a container with a higher z-index value." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/fab/fab.stories.ts" } }, { "kind": "js", "name": "Usage", "declaration": { "name": "Usage", "module": "src/components/fab/fab.stories.ts" } }, { "kind": "js", "name": "RanksAndVariants", "declaration": { "name": "RanksAndVariants", "module": "src/components/fab/fab.stories.ts" } }, { "kind": "js", "name": "IconButton", "declaration": { "name": "IconButton", "module": "src/components/fab/fab.stories.ts" } }, { "kind": "js", "name": "Color", "declaration": { "name": "Color", "module": "src/components/fab/fab.stories.ts" } }, { "kind": "js", "name": "Position", "declaration": { "name": "Position", "module": "src/components/fab/fab.stories.ts" } }, { "kind": "js", "name": "ZIndex", "declaration": { "name": "ZIndex", "module": "src/components/fab/fab.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/fab/fab.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { display: flex; z-index: 1050; position: fixed; inset: auto var(--gds-sys-space-3xl) var(--gds-sys-space-3xl) auto; } .button { box-shadow: var(--gds-sys-shadow-m-01), var(--gds-sys-shadow-m-02); block-size: calc(var(--_block-size) + var(--gds-sys-space-xs)); width: max-content; } ::slotted([gds-element='gds-signal']) { margin-left: var(--gds-sys-space-xs); } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/fab/fab.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/fab/fab.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFab", "declaration": { "name": "GdsFab", "module": "src/components/fab/fab.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/fab/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/fab/fab" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chips.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsFilterChips", "slots": [ { "description": "The filter chips to display", "name": "" } ], "members": [ { "kind": "field", "name": "value", "description": "The value of the currently selected chip or chips. This will be an array\nif multi-select is enabled.", "attribute": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Whether multiple chips can be selected at once.", "attribute": "multiple" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The accessible label for the control", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "chips", "description": "Returns the chips in the control", "readonly": true }, { "kind": "field", "name": "rowCollapse", "type": { "text": "boolean" }, "default": "false", "description": "Whether the chips should collapse into a single row when space is limited", "attribute": "row-collapse" }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ] }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "When a chip is clicked", "name": "change" }, { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Whether multiple chips can be selected at once.", "fieldName": "multiple", "attribute": "multiple" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The accessible label for the control", "fieldName": "label", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "row-collapse", "type": { "text": "boolean" }, "default": "false", "description": "Whether the chips should collapse into a single row when space is limited", "fieldName": "rowCollapse", "attribute": "row-collapse" }, { "name": "value", "description": "The value of the currently selected chip or chips. This will be an array\nif multi-select is enabled.", "fieldName": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsFormControlElement", "module": "/src/components/form/form-control" }, "tagName": "gds-filter-chips", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsFilterChip", "declaration": { "name": "GdsFilterChip", "module": "src/components/filter-chips/filter-chips.component.ts" } }, { "kind": "js", "name": "GdsFilterChips", "declaration": { "name": "GdsFilterChips", "module": "src/components/filter-chips/filter-chips.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chips.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Filter chips', component: 'gds-filter-chips', subcomponents: { FilterChip: 'gds-filter-chip' }, parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-filter-chips'), }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/filter-chips)\n | \n[Usage guidelines](https://designlibrary.sebgroup.com/components/component-filter-chip)\n\nFilter chip allows users to narrow down the data they want to see on the page." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "Usage", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` All Top news Division Global Country Large Corporate & Financial Institutions
Selected: top-news
`, }", "description": "This component works like many other types of input controls. A `value` property holds the currently\nselcted value/values and a `change` event is emitted when the value changes.\n\n## Single select\n\nBy default, the filter chips component is single select. Each filter-chip needs to have a unique value\nattribute. This determines the value of the parent components, and which chip is selected.\nChips without value cannot be selected.\n\n**Note:** It is important to remember to set the label attribute. Omitting it will cause poor\naccessibility for screen reader useSharedState. Internally in the component, the label attribute\nwill be used to set `aria-label` for the appropriate element." }, { "kind": "variable", "name": "MultiSelect", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` All Top news Division Global Country Large Corporate & Financial Institutions `, }", "description": "Setting the `multiple` attribute will allow users to select multiple filter chips. The value of the\ncomponent will be an array of the selected chip values." }, { "kind": "variable", "name": "RowCollapse", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` All Top news Division Global Country Large Corporate & Financial Institutions `, }", "description": "In some cases, layout constraints may require the filter chips to collapse into a single row.\n\nSetting the `row-collapse` attribute will enable this behavior when the chips require more than two rows. Instead, scrolling overflow will be used to accommodate the chips." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/filter-chips/filter-chips.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/filter-chips/filter-chips.stories.ts" } }, { "kind": "js", "name": "Usage", "declaration": { "name": "Usage", "module": "src/components/filter-chips/filter-chips.stories.ts" } }, { "kind": "js", "name": "MultiSelect", "declaration": { "name": "MultiSelect", "module": "src/components/filter-chips/filter-chips.stories.ts" } }, { "kind": "js", "name": "RowCollapse", "declaration": { "name": "RowCollapse", "module": "src/components/filter-chips/filter-chips.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chips.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset, transitional-styles; @layer base { :host { display: inline-block; max-width: 100%; } .chips { display: flex; flex-wrap: wrap; gap: 0.5rem; } .collapse { overflow: auto; scroll-snap-type: both mandatory; overscroll-behavior-x: contain; flex-wrap: nowrap; padding-bottom: 0.5rem; scrollbar-color: rgba(0, 0, 0, 0.5) transparent; scrollbar-width: thin; } ::slotted(*) { scroll-snap-align: start; scroll-snap-stop: always; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/filter-chips/filter-chips.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chips.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/filter-chips/filter-chips.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/filter-chips/filter-chips.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chips.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFilterChips", "declaration": { "name": "GdsFilterChips", "module": "src/components/filter-chips/filter-chips.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/filter-chips/filter-chips" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/filter-chips/filter-chip" } } ] }, { "kind": "javascript-module", "path": "src/components/flex/flex.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsFlex", "members": [ { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsDiv", "module": "/src/components/div/div.component" }, "tagName": "gds-flex", "customElement": true, "attributes": [ { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFlex", "declaration": { "name": "GdsFlex", "module": "src/components/flex/flex.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/flex/flex.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Flex', component: 'gds-flex', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-flex'), }, }", "description": "`gds-flex` extends `gds-div` and sets display to flex by default." }, { "kind": "variable", "name": "Flex", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Flex', render: (args) => html` Flex Example `, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/flex/flex.stories.ts" } }, { "kind": "js", "name": "Flex", "declaration": { "name": "Flex", "module": "src/components/flex/flex.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/flex/flex.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { display: flex; box-sizing: border-box; border-style: solid; border-width: 0; border-color: var(--gds-sys-color-border-neutral-02); } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/flex/flex.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/flex/flex.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFlex", "declaration": { "name": "GdsFlex", "module": "src/components/flex/flex.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/flex/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/flex/flex" } } ] }, { "kind": "javascript-module", "path": "src/components/form/form-control.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/form/form-request-submit-polyfill.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/form/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/form-summary" } } ] }, { "kind": "javascript-module", "path": "src/components/form-summary/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/form-summary/summary" } } ] }, { "kind": "javascript-module", "path": "src/components/form-summary/summary.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsFormSummary", "slots": [ { "description": "Optional slot for customizing the header of the summary.", "name": "header" } ], "members": [ { "kind": "field", "name": "hideErrors", "type": { "text": "boolean" }, "default": "false", "deprecated": "This no longer has any effect, and will be removed in a future release.", "attribute": "hideErrors" }, { "kind": "field", "name": "reactive", "type": { "text": "boolean" }, "default": "false", "description": "Whether to refresh the summary automatically as controls in the form change validation state.\n\nAvoid this setting if the summary is located above the form controls, as it may cause the form\nto jump around as the summary is updated.", "attribute": "reactive" }, { "kind": "field", "name": "errorCount", "description": "The current number of errors displayed in the summary.\n\nThis is a convenience property that can be used to display the number of errors in the summary.", "readonly": true }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Focuses the first focusable element in the summary." }, { "kind": "method", "name": "refresh", "description": "Refresh the component to reflect the current state of the form." }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "hideErrors", "type": { "text": "boolean" }, "default": "false", "deprecated": "This no longer has any effect, and will be removed in a future release.", "fieldName": "hideErrors" }, { "name": "reactive", "type": { "text": "boolean" }, "default": "false", "description": "Whether to refresh the summary automatically as controls in the form change validation state.\n\nAvoid this setting if the summary is located above the form controls, as it may cause the form\nto jump around as the summary is updated.", "fieldName": "reactive" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-form-summary", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFormSummary", "declaration": { "name": "GdsFormSummary", "module": "src/components/form-summary/summary.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/form-summary/summary.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Form summary', component: 'gds-form-summary', parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-form-summary'), }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/form-summary)\n | \n[Usage guidelines](https://designlibrary.sebgroup.com/components/component-errorsummary)\n\nForm summary shows all form errors in one place." }, { "kind": "variable", "name": "Usage", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html`
Launch control { if (el.value.length === 0) return [ { ...el.validity, valid: false, customError: true }, 'At least one mission type is required', ] }, }} > { if (el.value === undefined) return [ { ...el.validity, valid: false, customError: true }, 'A rocket type is required', ] }, }} > { if (el.value !== 'cat') return [ { ...el.validity, valid: false, customError: true }, el.value === undefined ? 'An astronaut is required' : 'Only cats can pilot rockets!', ] }, }} > Pick your astronaut Dog Cat Fish { if (el.value === undefined) return [ { ...el.validity, valid: false, customError: true }, 'A date is required', ] }, }} > { if (el.value === '') return [ { ...el.validity, valid: false, customError: true }, 'A designation is required', ] }, }} > { if (el.value.length === 0) return [ { ...el.validity, valid: false, customError: true }, 'You must agree to the terms and conditions', ] }, }} > Reset Launch
`, }", "description": "To use the `gds-form-summary` component, simply place it inside a form element.\n\nIn this example we're using a reactive form summary below the form controls. The `reactive` attribute makes the summary\nupdate automatically as the user interacts with the form." }, { "kind": "variable", "name": "ManualUpdate", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html`
{ if (el.value === '') return [ { ...el.validity, valid: false, customError: true }, 'A designation is required', ] }, }} > Submit
`, }", "description": "The `gds-form-summary` component can also be used in a non-reactive way.\nIn this example, the summary is placed above the form controls and\nis updated manually when the user clicks the \"Submit\" button." }, { "kind": "variable", "name": "NativeControls", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html`
`, }", "description": "`gds-form-summary` can also be used with native controls by specifying label and error message as data attributes on the control.\nAny control that has `aria-invalid` set to `true` will be included in the summary." }, { "kind": "variable", "name": "WithFieldsets", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html`
Launch control { if (el.value === '') return [ { ...el.validity, valid: false, customError: true }, 'A mission name is required', ] }, }} >
Crew details { if (el.value === '') return [ { ...el.validity, valid: false, customError: true }, 'A commander is required', ] }, }} > { if (el.value === '') return [ { ...el.validity, valid: false, customError: true }, 'A pilot is required', ] }, }} >
Vehicle details { if (el.value === undefined) return [ { ...el.validity, valid: false, customError: true }, 'A rocket type is required', ] }, }} > Select a rocket Falcon Starship { if (el.value === '') return [ { ...el.validity, valid: false, customError: true }, 'A launch pad is required', ] }, }} >
Reset Launch
`, }", "description": "When form controls are wrapped in a `
`, the summary groups the errors\nunder the fieldset's `` text in a nested list.\n\nControls outside any fieldset are listed at the top level as usual.\n\nNote: Fieldsets does not currently have any standardised design in Green. They are\nmainly considered a semantic grouping element, and styling will differ from case\nto case. Below, we just leave default browser styling for clarity in the example.\nOftentimes there will not be any styling at all, just a heading element\nused as legend." }, { "kind": "variable", "name": "CustomHeader", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html`
Launch control { if (el.value === '') return [ { ...el.validity, valid: false, customError: true }, 'A mission name is required', ] }, }} > { if (el.value === '') return [ { ...el.validity, valid: false, customError: true }, 'A designation is required', ] }, }} > Please fix the errors below before submitting Reset Launch
`, }", "description": "Use the `header` slot to provide a custom header for the summary.\n\nThis example uses a `gds-alert` with a `button-label` to show an action button in the header." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/form-summary/summary.stories.ts" } }, { "kind": "js", "name": "Usage", "declaration": { "name": "Usage", "module": "src/components/form-summary/summary.stories.ts" } }, { "kind": "js", "name": "ManualUpdate", "declaration": { "name": "ManualUpdate", "module": "src/components/form-summary/summary.stories.ts" } }, { "kind": "js", "name": "NativeControls", "declaration": { "name": "NativeControls", "module": "src/components/form-summary/summary.stories.ts" } }, { "kind": "js", "name": "WithFieldsets", "declaration": { "name": "WithFieldsets", "module": "src/components/form-summary/summary.stories.ts" } }, { "kind": "js", "name": "CustomHeader", "declaration": { "name": "CustomHeader", "module": "src/components/form-summary/summary.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/form-summary/summary.styles.ts", "declarations": [], "exports": [ { "kind": "js", "name": "default", "declaration": { "module": "src/components/form-summary/summary.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/form-summary/summary.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFormSummary", "declaration": { "name": "GdsFormSummary", "module": "src/components/form-summary/summary.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/formatted-text.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/formatted-text/formatters.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/formatted-text/account/account-formatter" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/formatted-text/date/date-time-formatter" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/formatted-text/number/number-formatter" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/formatted-text/formatters" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/formatted-text/account" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/formatted-text/date" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/formatted-text/number" } } ] }, { "kind": "javascript-module", "path": "src/components/grid/grid.component.ts", "declarations": [ { "kind": "class", "description": "The `gds-grid` is a custom element that provides a flexible grid system. It uses CSS grid layout to arrange its child elements into columns. This component is highly customizable and responsive, allowing you to specify the number of `columns`, `gap`, `padding`, and fluidity for different devices with automated column size based on the content using the `auto-columns` attribute.", "name": "GdsGrid", "members": [ { "kind": "field", "name": "columns", "type": { "text": "string | undefined" }, "description": "The number of columns to divide the space into. Accepts a unitless number. Example: `1; m { 2 }; l { 4 }` to vary number of columns based on viewport size." }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Defines the gap size between grid items. Uses same format as the CSS gap property, and expects space tokens. This can be a single value that applies to all breakpoints, or a string of three space-separated tokens in the format \"l:desktop m:tablet s:mobile\", each token specifying the gap size for that device type respectively.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'auto-columns'", "type": { "text": "string | undefined" }, "description": "Defines the minimum column width. If set, the grid adjusts column size based on content and available width, even without other attributes. Accepts any valid CSS units." }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsDiv", "module": "/src/components/div/div.component" }, "tagName": "gds-grid", "customElement": true, "attributes": [ { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsGrid", "declaration": { "name": "GdsGrid", "module": "src/components/grid/grid.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/grid/grid.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Grid', component: 'gds-grid', tags: ['autodocs'], }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/grid)\n\nThe `gds-grid` is a custom element that provides a flexible grid system. It uses CSS grid layout to arrange its child elements into columns. This component is highly customizable and responsive, allowing you to specify the number of `columns`, `gap`, `padding`, and fluidity for different devices with automated column size based on the content using the `auto-columns` attribute." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "Usage", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` COL: 01 COL: 02 COL: 03 COL: 04 COL: 05 COL: 06 COL: 07 COL: 08 COL: 09 COL: 10 COL: 11 COL: 12 `, }", "description": "To use the `gds-grid`, you add it to your HTML and specify the number of `columns` for `desktop`, `tablet`, and `mobile` devices using the `columns` attribute. The `columns`, `gap`, `row-gap` and `padding` attributes can take either a single value or a string of three tokens separated by spaces, each prefixed with `l` for `desktop`, `m` for `tablet`, and `s` for mobile.\n\nIf a single value is provided, it will be used for all screen sizes. If three tokens are provided, each screen size will use the value specified for it.\n\n```html\n\n\n \n\n\n\n\n \n\n```\n\n#### Example\n\nThis example shows a grid with 8 columns on desktop, 4 on tablet, and 2 on mobile. It also has a gap of `l` on desktop, `m` on tablet, and `s` on mobile. The padding is `2xl` on desktop, `l` on tablet, and `xs` on mobile." }, { "kind": "variable", "name": "AllBreakpoints", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Breakpoints + Auto Columns', render: (args) => html` COL: 01 COL: 02 COL: 03 COL: 04 COL: 05 COL: 06 COL: 07 COL: 08 `, }", "description": "This example shows a grid with `4` columns on all breakpoints desktop, tablet, and on mobile. It also has a gap of `2xl` on all breakpoints. The padding is `l` on all breakpoints. As well as `auto-columns` attribute is set to `100` which will make the columns to be `~100px` wide." }, { "kind": "variable", "name": "AutoColumns", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Auto Columns', render: (args) => html` COL: 01 COL: 02 COL: 03 COL: 04 COL: 05 COL: 06 COL: 07 COL: 08 `, }", "description": "#### Explanation of the Formula\n\n1. **Variables**:\n - **W**: Total available width of the grid container (e.g., `width: 100%;`).\n - **C**: Number of columns (in this example, it will depend on how many items fit in the available width).\n - **G**: Width of a single gap (in this case, `gap: 10px;`).\n\n2. **Formula**:\n\n\n\n\n\n3. **How It Works**:\n - **Calculate Total Gap Width**: The total gap width is calculated as `(C - 1) x G`.\n - **Subtract from Total Width**: Subtract the total gap width from the total available width `W`.\n - **Divide by Number of Columns**: Divide the remaining width by the number of columns `C` to get the maximum column width.\n\n### Example Calculation\n\nAssuming:\n- Total available width `W = 500px`\n- Number of columns `C = 3`\n- Gap width `G = 10px`\n\n**Calculation**:\n1. Total gap width: `(3 - 1) x 10 = 20px`\n2. Remaining width: `500 - 20 = 480px`\n3. Max column width: `480 / 3 = 160px`\n\n### Result\n\nEach column would have a maximum width of **160px** while respecting the gaps between them. If the viewport is resized, the grid will automatically * adjust the number of columns and their widths based on the available space.\n\nThis example demonstrates how the `auto-columns` attribute and the formula work together in a CSS Grid Layout.\n\n
\n\nThis example has the fluid attribute and it will adapt the content automatically based on the available width and min inline size.\nThe `auto-columns` attribute is set to `240` which will make the columns to be `240px` no matter the screen/container size." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/grid/grid.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/grid/grid.stories.ts" } }, { "kind": "js", "name": "Usage", "declaration": { "name": "Usage", "module": "src/components/grid/grid.stories.ts" } }, { "kind": "js", "name": "AllBreakpoints", "declaration": { "name": "AllBreakpoints", "module": "src/components/grid/grid.stories.ts" } }, { "kind": "js", "name": "AutoColumns", "declaration": { "name": "AutoColumns", "module": "src/components/grid/grid.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/grid/grid.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { --_c: 12; --_grid-col: repeat(var(--_c), 1fr); width: 100%; display: grid; grid-template-columns: var(--_grid-col); grid-column-gap: var(--_gap-column, 0px); grid-row-gap: var(--_gap-row, 0px); box-sizing: border-box; } :host([auto-columns]) { --_col-count: var(--_c, 0); --_gap-count: calc(var(--_col-count) - 1); --_total-gap-width: calc(var(--_gap-count) * var(--_gap-column, 0px)); --_col-width-max: calc( (100% - var(--_total-gap-width)) / var(--_col-count) ); grid-template-columns: repeat( auto-fill, minmax(max(var(--_col-width), var(--_col-width-max)), 1fr) ); } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/grid/grid.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/grid/grid.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsGrid", "declaration": { "name": "GdsGrid", "module": "src/components/grid/grid.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/grid/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/grid/grid" } } ] }, { "kind": "javascript-module", "path": "src/components/grouped-list/grouped-list.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsGroupedList", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label for the list that will render in the shadowDOM as the first
  • element in the list with the class `gds-list-heading`", "attribute": "label" }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label for the list that will render in the shadowDOM as the first
  • element in the list with the class `gds-list-heading`", "fieldName": "label" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-grouped-list", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsListItem", "declaration": { "name": "GdsListItem", "module": "src/components/grouped-list/grouped-list.component.ts" } }, { "kind": "js", "name": "GdsGroupedList", "declaration": { "name": "GdsGroupedList", "module": "src/components/grouped-list/grouped-list.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/grouped-list/grouped-list.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Grouped List', component: 'gds-grouped-list', subcomponents: { GdsListItem: 'gds-list-item' }, parameters: { layout: 'centered', }, tags: ['autodocs'], }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/grouped-list)\n | \n[Usage guidelines](https://designlibrary.sebgroup.com/components/component-list)\n\nist are used to list many datapoints with labels in a structured way. They may be grouped under\nheading and they may have a link or button added to act on the data being displayed." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "WithValues", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Grouped list with values', render: (args) => html`
    Key 1
    Value 1
    Key 2
    Value 2
    Key 3
    Value 3
    Key 4
    Value 4
    Key 5
    Value 5     `, }", "description": "By default, the list items are displayed as `flex` containers with `space-between` alignment." }, { "kind": "variable", "name": "WithValuesAndAction", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Grouped list with values and action', render: (args) => html`
    Key 1
    Value 1
    Key 2
    Value 2
    Key 3
    Value 3
    Key 4
    Value 4
    Key 5
    Value 5     `, }", "description": "Elements such as links or buttons can be slotted into the list items." }, { "kind": "variable", "name": "AdjustingAppearance", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html`
    Key 1
    Value 1
    Key 2
    Value 2
    Key 3
    Value 3
    Key 1
    Value 1
    Key 2
    Value 2
    Key 3
    Value 3     `, }", "description": "The slotted elements can be styled using inline styles or CSS classes." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/grouped-list/grouped-list.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/grouped-list/grouped-list.stories.ts" } }, { "kind": "js", "name": "WithValues", "declaration": { "name": "WithValues", "module": "src/components/grouped-list/grouped-list.stories.ts" } }, { "kind": "js", "name": "WithValuesAndAction", "declaration": { "name": "WithValuesAndAction", "module": "src/components/grouped-list/grouped-list.stories.ts" } }, { "kind": "js", "name": "AdjustingAppearance", "declaration": { "name": "AdjustingAppearance", "module": "src/components/grouped-list/grouped-list.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/grouped-list/grouped-list.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` .gds-list-heading { padding: var(--gds-sys-space-xs) var(--gds-sys-space-m); background: var(--gds-sys-color-l3-neutral-02); border-radius: var(--gds-sys-radius-s); } ::slotted([gds-element='gds-list-item']) { padding: var(--gds-sys-space-xs) var(--gds-sys-space-m); border-bottom-color: var(--gds-sys-color-border-neutral-03); border-bottom-width: var(--gds-sys-space-5xs); border-bottom-style: solid; display: flex; justify-content: space-between; gap: var(--gds-sys-space-3xs); } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/grouped-list/grouped-list.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/grouped-list/grouped-list.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/grouped-list/grouped-list.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/grouped-list/grouped-list.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/grouped-list/grouped-list.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsGroupedList", "declaration": { "name": "GdsGroupedList", "module": "src/components/grouped-list/grouped-list.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/grouped-list/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/grouped-list/grouped-list" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/grouped-list/list-item" } } ] }, { "kind": "javascript-module", "path": "src/components/grouped-list/list-item.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsListItem", "members": [ { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-list-item", "customElement": true, "attributes": [ { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsListItem", "declaration": { "name": "GdsListItem", "module": "src/components/grouped-list/list-item.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/grouped-list/list-item.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsListItem", "declaration": { "name": "GdsListItem", "module": "src/components/grouped-list/list-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icon.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsIcon", "cssParts": [ { "description": "The icon SVG element.", "name": "icon" } ], "members": [ { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once." }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid" }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke" }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level" }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label" }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid" }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke" }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsIcon", "declaration": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icon.deprecated.ts", "declarations": [ { "kind": "variable", "name": "deprecatedIcons", "type": { "text": "Record" } } ], "exports": [ { "kind": "js", "name": "deprecatedIcons", "declaration": { "name": "deprecatedIcons", "module": "src/components/icon/icon.deprecated.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icon.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Icon', component: 'gds-icon-bank', tags: ['autodocs'], }", "description": "An icon helps communicate meaning quickly, enhances visual hierarchy, and supports navigation or interaction." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { solid: false, size: 'xl', }, }" }, { "kind": "variable", "name": "Solid", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { solid: true, size: 'xl', }, }", "description": "Toggle between outline and solid icon styles using the `solid` attribute.\nToggle between outline and solid icon styles using the `solid` attribute." }, { "kind": "variable", "name": "Size", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { ...DefaultParams.parameters!.args, size: '2xl', }, }", "description": "The default icon size is equal to 1lh (1 line height).
    \nYou can change the icon size by setting the `size` attribute.
    \nThe size property accepts all the size tokens and also custom value like px or lh.\n\n```html\n\n\n\n\n```" }, { "kind": "variable", "name": "Stroke", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { solid: false, stroke: '2', size: 'xl', }, }", "description": "You can change the icon stroke by setting the `stroke` attribute.\n\n```html\n\n```" }, { "kind": "variable", "name": "Color", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { solid: false, color: 'tertiary', }, }", "description": "\nSet icon colors using the `color` attribute. Supports design system tokens and transparency.\n\n```html\n\n\n\n\n\n\n\n\n```" }, { "kind": "variable", "name": "Label", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { label: 'Bank', }, }", "description": "Icons have the role of `presentation`, when there is no label provided. This means that the icon will be ignored by screen readers." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/icon/icon.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/icon/icon.stories.ts" } }, { "kind": "js", "name": "Solid", "declaration": { "name": "Solid", "module": "src/components/icon/icon.stories.ts" } }, { "kind": "js", "name": "Size", "declaration": { "name": "Size", "module": "src/components/icon/icon.stories.ts" } }, { "kind": "js", "name": "Stroke", "declaration": { "name": "Stroke", "module": "src/components/icon/icon.stories.ts" } }, { "kind": "js", "name": "Color", "declaration": { "name": "Color", "module": "src/components/icon/icon.stories.ts" } }, { "kind": "js", "name": "Label", "declaration": { "name": "Label", "module": "src/components/icon/icon.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icon.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer icon; @layer icon { :host { display: inline-block; } svg { display: block; height: 1lh; width: auto; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/icon/icon.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icon.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsIcon", "declaration": { "name": "GdsIcon", "module": "src/components/icon/icon.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icon" } } ] }, { "kind": "javascript-module", "path": "src/components/img/img.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsImg", "members": [ { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Controls the aspect ratio of the image.\nSupports all common aspect ratios like 16/9, 4/3, 1/1, etc.\n\nYou can apply the aspect ratio like this:\n```html\n\n```\nThe above example will apply the aspect ratio of 16/9.\n\nYou can also apply different aspect ratios for different screen sizes like this:\n```html\n\n```\n\nThe above example will apply the aspect ratio of 16/9 for large screens, 4/3 for medium screens, and 1/1 for small screens." }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Controls the border-radius property of the image.\nSupports all the size tokens from the design system.\n\nYou can apply radius in each corner like this:\n```html\n\n```\n\nAlso for different breakpoints like this:\n```html\n\n```", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'object-fit'", "type": { "text": "string | undefined" }, "description": "Controls the object-fit property of the image.\n\nYou can apply fit like this:\n```html\n\n```\n\n The above example will apply the object-fit style of cover." }, { "kind": "field", "name": "'object-position'", "type": { "text": "string | undefined" }, "description": "Controls the `object-position` of the img.\nSupports all common CSS values." }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "src", "type": { "text": "string | undefined" }, "description": "The URL of the image", "attribute": "src", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "field", "name": "srcset", "type": { "text": "string | undefined" }, "description": "The srcset attribute for responsive images\nFormat: \"image.jpg 1x, image-2x.jpg 2x\" or \"image-320.jpg 320w, image-640.jpg 640w\"", "attribute": "srcset", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "field", "name": "sizes", "type": { "text": "string | undefined" }, "description": "The sizes attribute for responsive images\nFormat: \"(max-width: 320px) 280px, (max-width: 640px) 580px, 800px\"", "attribute": "sizes", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "field", "name": "alt", "type": { "text": "string | undefined" }, "description": "Alternative text description of the image\nRequired for accessibility. Should be empty string if image is decorative.", "attribute": "alt", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "field", "name": "loading", "type": { "text": "'lazy' | 'eager' | undefined" }, "default": "'lazy'", "description": "Loading strategy for the image", "attribute": "loading", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "field", "name": "decoding", "type": { "text": "'auto' | 'sync' | 'async' | undefined" }, "default": "'auto'", "description": "Decoding strategy for the image", "attribute": "decoding", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withPositioningProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeYProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withImageProps", "module": "/src/utils/mixins/props-image" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-img", "customElement": true, "attributes": [ { "name": "src", "type": { "text": "string | undefined" }, "description": "The URL of the image", "fieldName": "src", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "srcset", "type": { "text": "string | undefined" }, "description": "The srcset attribute for responsive images\nFormat: \"image.jpg 1x, image-2x.jpg 2x\" or \"image-320.jpg 320w, image-640.jpg 640w\"", "fieldName": "srcset", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "sizes", "type": { "text": "string | undefined" }, "description": "The sizes attribute for responsive images\nFormat: \"(max-width: 320px) 280px, (max-width: 640px) 580px, 800px\"", "fieldName": "sizes", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "alt", "type": { "text": "string | undefined" }, "description": "Alternative text description of the image\nRequired for accessibility. Should be empty string if image is decorative.", "fieldName": "alt", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "loading", "type": { "text": "'lazy' | 'eager' | undefined" }, "default": "'lazy'", "description": "Loading strategy for the image", "fieldName": "loading", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "decoding", "type": { "text": "'auto' | 'sync' | 'async' | undefined" }, "default": "'auto'", "description": "Decoding strategy for the image", "fieldName": "decoding", "inheritedFrom": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsImg", "declaration": { "name": "GdsImg", "module": "src/components/img/img.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/img/img.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Image', component: 'gds-img', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-img'), }, }", "description": "An image displays media with configurable dimensions and styling properties." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "Responsive", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { src: 'https://api.seb.io/assets/img-1200.jpg', // Responsive image sources for different viewport sizes srcset: ` https://api.seb.io/assets/img-320.jpg 320w, https://api.seb.io/assets/img-480.jpg 480w, https://api.seb.io/assets/img-800.jpg 800w, https://api.seb.io/assets/img-1200.jpg 1200w, https://api.seb.io/assets/img-2400.jpg 2x `, // Define which image size to use at different viewport widths sizes: ` (max-width: 320px) 280px, (max-width: 480px) 440px, (max-width: 800px) 760px, (max-width: 1200px) 1100px, 100vw `, alt: 'Responsive image example showing different sizes based on viewport', 'border-radius': 's', }, parameters: { docs: { description: { story: ` ### Responsive Image Example This example demonstrates responsive image loading using \\`srcset\\` and \\`sizes\\`: - **srcset**: Provides different image versions: - 320px wide version for small devices - 480px wide version for medium devices - 800px wide version for larger devices - 1200px wide version for desktop - 2x version for high-DPI displays - **sizes**: Tells the browser which image size to use: - Under 320px viewport: Use 280px wide image - 320px-480px viewport: Use 440px wide image - 480px-800px viewport: Use 760px wide image - 800px-1200px viewport: Use 1100px wide image - Above 1200px: Use full viewport width This ensures optimal image loading based on device size and screen resolution. \\`\\`\\`html \\`\\`\\` `, }, }, }, }" }, { "kind": "variable", "name": "HighDPI", "type": { "text": "Story" }, "default": "{ ...DefaultParams, args: { src: 'https://api.seb.io/assets/img-1200.jpg', // Device pixel ratio (DPR) specific sources srcset: ` https://api.seb.io/assets/img-380.jpg 1x, https://api.seb.io/assets/img-800.jpg 2x, https://api.seb.io/assets/img-2400.jpg 3x `, alt: 'High-DPI optimized image example', 'border-radius': 's', }, parameters: { docs: { description: { story: ` ### High-DPI Display Example This example shows how to provide different image versions for various device pixel ratios: - 1x for standard displays - 2x for Retina displays - 3x for Super Retina displays The browser will automatically choose the best version based on the device's capabilities. `, }, }, }, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/img/img.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/img/img.stories.ts" } }, { "kind": "js", "name": "Responsive", "declaration": { "name": "Responsive", "module": "src/components/img/img.stories.ts" } }, { "kind": "js", "name": "HighDPI", "declaration": { "name": "HighDPI", "module": "src/components/img/img.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/img/img.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { display: block; margin: 0; padding: 0; box-sizing: border-box; font-size: 0; width: 100%; height: auto; overflow: hidden; } img { display: flex; width: 100%; height: 100%; } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/img/img.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/img/img.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsImg", "declaration": { "name": "GdsImg", "module": "src/components/img/img.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/img/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/img/img" } } ] }, { "kind": "javascript-module", "path": "src/components/input/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/input/input" } } ] }, { "kind": "javascript-module", "path": "src/components/input/input.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsInput", "slots": [ { "description": "Accepts `gds-icon-[ICON_NAME]`. Use this to place an icon in the start of the field.", "name": "lead" }, { "description": "Accepts `gds-badge`. Use this to place a badge in the field, for displaying currency for example.", "name": "trail" }, { "description": "A longer supporting text can be placed here. It will be displayed in a panel when the user clicks the info button.", "name": "extended-supporting-text" } ], "events": [ { "description": "Fired when the clear button is clicked.", "name": "gds-input-cleared" }, { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "Input", "module": "src/components/input/input.component.ts" }, "tagName": "gds-input", "customElement": true, "summary": "A custom input element that can be used in forms.", "members": [ { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "supportingText", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field.\nThis text provides additional context or information to the user.", "attribute": "supporting-text", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "showExtendedSupportingText", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "attribute": "show-extended-supporting-text", "reflects": true, "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field should be clearable or not. Clearable fields will display a clear button when\nthe field has a value.", "attribute": "clearable", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "maxlength", "type": { "text": "number" }, "description": "The maximum number of characters allowed in the field.", "attribute": "maxlength", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size of texts and height of the field.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Hides the header and the footer, while still keeping the accessible label\n\nAlways set the `label` attribute, and if you need to hide it, add this attribute and keep `label` set.", "attribute": "plain", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "type", "type": { "text": "| 'date'\n | 'datetime-local'\n | 'email'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'text'\n | 'time'\n | 'url'" }, "default": "'text'", "description": "The type of input. Works the same as a native `` element, but only a subset of types are supported. Defaults\nto `text`.", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "min", "type": { "text": "number | string | undefined" }, "description": "The input's minimum value. Only applies to date and number input types.", "attribute": "min", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "max", "type": { "text": "number | string | undefined" }, "description": "The input's maximum value. Only applies to date and number input types.", "attribute": "max", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "step", "type": { "text": "number | 'any' | undefined" }, "description": "Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is\nimplied, allowing any numeric value. Only applies to date and number input types.", "attribute": "step", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "autocapitalize", "type": { "text": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'" }, "default": "'off'", "description": "Controls whether and how text input is automatically capitalized as it is entered by the user.", "attribute": "autocapitalize", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "autocorrect", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the browser's autocorrect feature is on or off.", "attribute": "autocorrect", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "autocomplete", "type": { "text": "string | undefined" }, "description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.", "attribute": "autocomplete", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "autofocus", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the input should receive focus on page load.", "attribute": "autofocus", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "enterkeyhint", "type": { "text": "| 'enter'\n | 'done'\n | 'go'\n | 'next'\n | 'previous'\n | 'search'\n | 'send' | undefined" }, "description": "Used to customize the label or icon of the Enter key on virtual keyboards.", "attribute": "enterkeyhint", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "spellcheck", "type": { "text": "boolean" }, "default": "true", "description": "Enables spell checking on the input.", "attribute": "spellcheck", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "inputmode", "type": { "text": "| 'none'\n | 'text'\n | 'decimal'\n | 'numeric'\n | 'tel'\n | 'search'\n | 'email'\n | 'url' | undefined" }, "description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.", "attribute": "inputmode", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "charCounterCallback", "default": "charCounterCallbackDefault", "description": "This callback allows for customization of the character counter. It should return a tuple\nwith the first value being the number of remaining characters, and the second value being\nthe variant of the badge. If the second value is `false`, no badge will be displayed.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Move focus to the input element.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "method", "name": "select", "return": { "type": { "text": "void" } }, "description": "Selects all the text in the input element.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "method", "name": "setRangeText", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "args", "type": { "text": "Parameters" } } ], "description": "Sets the value of the input element, replacing a range of text.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "method", "name": "setSelectionRange", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "args", "type": { "text": "Parameters" } } ], "description": "Sets the start and end positions of a selection in the input element.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "method", "name": "showPicker", "return": { "type": { "text": "void" } }, "description": "Opens the browser's picker interface for inputs that support it (e.g., date picker for date inputs).", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "method", "name": "stepDown", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "n", "optional": true, "type": { "text": "number" } } ], "description": "Decreases the value of the input element by the specified step.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "method", "name": "stepUp", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "n", "optional": true, "type": { "text": "number" } } ], "description": "Increases the value of the input element by the specified step.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "selectionStart", "description": "Sets the position of the start of the current text selection in the input element.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "selectionEnd", "description": "Sets the position of the end of the current text selection in the input element.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "selectionDirection", "description": "Sets the direction of the current text selection in the input element.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "method", "name": "test_getClearButton", "description": "A reference to the clear button element. Returns null if there is no clear button.\nIntended for use in integration tests.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "method", "name": "test_getFieldElement", "description": "A reference to the field element. This does not refer to the input element itself,\nbut the wrapper that makes up the visual field.\nIntended for use in integration tests.", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "method", "name": "_getValidityAnchor", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "kind": "field", "name": "value", "description": "Get or set the value of the form control.", "attribute": "value", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "supporting-text", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field.\nThis text provides additional context or information to the user.", "fieldName": "supportingText", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "show-extended-supporting-text", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "fieldName": "showExtendedSupportingText", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field should be clearable or not. Clearable fields will display a clear button when\nthe field has a value.", "fieldName": "clearable", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "maxlength", "type": { "text": "number" }, "description": "The maximum number of characters allowed in the field.", "fieldName": "maxlength", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size of texts and height of the field.", "fieldName": "size", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Hides the header and the footer, while still keeping the accessible label\n\nAlways set the `label` attribute, and if you need to hide it, add this attribute and keep `label` set.", "fieldName": "plain", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "type", "type": { "text": "| 'date'\n | 'datetime-local'\n | 'email'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'text'\n | 'time'\n | 'url'" }, "default": "'text'", "description": "The type of input. Works the same as a native `` element, but only a subset of types are supported. Defaults\nto `text`.", "fieldName": "type", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "min", "type": { "text": "number | string | undefined" }, "description": "The input's minimum value. Only applies to date and number input types.", "fieldName": "min", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "max", "type": { "text": "number | string | undefined" }, "description": "The input's maximum value. Only applies to date and number input types.", "fieldName": "max", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "step", "type": { "text": "number | 'any' | undefined" }, "description": "Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is\nimplied, allowing any numeric value. Only applies to date and number input types.", "fieldName": "step", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "autocapitalize", "type": { "text": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'" }, "default": "'off'", "description": "Controls whether and how text input is automatically capitalized as it is entered by the user.", "fieldName": "autocapitalize", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "autocorrect", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the browser's autocorrect feature is on or off.", "fieldName": "autocorrect", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "autocomplete", "type": { "text": "string | undefined" }, "description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.", "fieldName": "autocomplete", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "autofocus", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the input should receive focus on page load.", "fieldName": "autofocus", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "enterkeyhint", "type": { "text": "| 'enter'\n | 'done'\n | 'go'\n | 'next'\n | 'previous'\n | 'search'\n | 'send' | undefined" }, "description": "Used to customize the label or icon of the Enter key on virtual keyboards.", "fieldName": "enterkeyhint", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "spellcheck", "type": { "text": "boolean" }, "default": "true", "description": "Enables spell checking on the input.", "fieldName": "spellcheck", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "inputmode", "type": { "text": "| 'none'\n | 'text'\n | 'decimal'\n | 'numeric'\n | 'tel'\n | 'search'\n | 'email'\n | 'url' | undefined" }, "description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.", "fieldName": "inputmode", "inheritedFrom": { "name": "Input", "module": "src/components/input/input.component.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "fieldName": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "value", "description": "Get or set the value of the form control.", "fieldName": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsInput", "declaration": { "name": "GdsInput", "module": "src/components/input/input.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/input/input.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Input', component: 'gds-input', parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-input'), value: { control: 'text', }, variant: { options: ['default'], control: { type: 'select' }, }, size: { options: ['large', 'small'], control: { type: 'select' }, }, invalid: { control: 'boolean', }, }, }", "description": "An input lets users enter and edit text or numerical values in forms." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Default', }" }, { "kind": "variable", "name": "Size", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Size', render: () => html` { if (el.value === '') return [ { ...el.validity, valid: false, customError: true, }, 'Required field.', ] else if (el.value.length !== 12 || isNaN(el.value)) return [ { ...el.validity, valid: false, customError: true, }, 'The value must be 12 characters long.', ] }, }} > Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "The `size` property can be set to 'small' to reduce the size of the input field.
    \n**@property size** - The size of the input field.\n\n```html\n \n```" }, { "kind": "variable", "name": "Lead", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Slot: Lead', render: () => html` `, }", "description": "**@slot lead** - Slot for an icon or other content to be placed at the beginning of the input field.\n\n```html\n \n \n```" }, { "kind": "variable", "name": "Trail", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Slot: Trail', render: () => html` USD `, }", "description": "\n**@slot trail** - Slot for an icon or other content to be placed at the end of the input field.\n\n```html\n \n USD\n```" }, { "kind": "variable", "name": "Length", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Length', render: () => html` `, }", "description": "The `length` property can be set to a number to limit the number of characters that can be entered into the input field.
    A badge will be displayed, updating as the input approaches the character limit.\n\n**@property maxLength** - The maximum number of characters that can be entered into the input field.\n\n```html\n \n```" }, { "kind": "variable", "name": "Clearable", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Clearable', render: () => html` `, }", "description": "When the `clearable` property is set, a clear button is added, allowing users to quickly clear the text." }, { "kind": "variable", "name": "SupportingText", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Supporting Text', render: () => html` `, }", "description": "The `supporting-text` property can be set to a string to provide additional information about the input field.\n\n**@property supporting-text** - Additional information about the input field.\n\n```html\n \n```" }, { "kind": "variable", "name": "ExtendedSupportingText", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Extended Supporting Text', render: () => html` Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "The `extended-supporting-text` slot can be used to provide extended information about the input field.
    \nThe slot will show by default when the `show-extended-supporting-text` property is set.
    \nIf not specified, the slot will be hidden and a companion icon will be displayed to indicate that more information is available.\n\n**@slot extended-supporting-text** - Extended information about the input field.\n\n```html\n\n Extended supporting text\n\n```\n\n**@property show-extended-supporting-text** - Shows the extended supporting text.\n\n```html\n\n```" }, { "kind": "variable", "name": "Validation", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Validation', render: () => html` { if (el.value === '') return [ { ...el.validity, valid: false, customError: true, }, 'Error message.', ] else if (el.value.length !== 12 || isNaN(el.value)) return [ { ...el.validity, valid: false, customError: true, }, 'The value must be 12 characters long.', ] }, }} > Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. { if (el.value === '') return [ { ...el.validity, valid: false, customError: true, }, 'This displays if the input doesn`t have any value.', ] else if (el.value.length !== 12 || isNaN(el.value)) return [ { ...el.validity, valid: false, customError: true, }, 'The value must be 12 characters long. ', ] }, }} > `, }", "description": "Input has built-in support for form validation.
    The validation feature is built on top of the browsers native validation features, using `ElementInternals` and `Constraint Validation API`.\n\nValidation is configured by adding a validator to a form element.
    A validator is an object that implements the `GdsValidator` interface:\n\n```html\n {\n if (el.value === '')\n return [\n {\n ...el.validity,\n valid: false,\n customError: true,\n },\n 'Error message.',\n ]\n },\n }}>\n```\n**@property invalid** - Indicates that the input field contains an error.\n\n```html\n\n```" }, { "kind": "variable", "name": "StandardAttributes", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Standard Attributes', render: () => html` `, }", "description": "Most standard attributes are supported, and will be forwarded to the internal input element." }, { "kind": "variable", "name": "Disabled", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Disabled', render: () => html` `, }", "description": "The `disabled` property can be set to disable the input field.\n\n**@property disabled** - Disables the input field.\n\n```html\n \n```" }, { "kind": "variable", "name": "CustomCounterBadge", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Custom counter badge', render: () => html` { let badgeType: GdsBadge['variant'] = 'positive' if (inp.value) { switch (inp.value.length % 5) { case 0: badgeType = 'positive' break case 1: badgeType = 'negative' break case 2: badgeType = 'notice' break case 3: badgeType = 'warning' break case 4: badgeType = 'information' break } } return [inp.value!.length, badgeType] as const }} > `, }", "description": "The `charCounterCallback` property can be used to customize the character counter badge.\n\nCheck the [story source](https://github.com/seb-oss/green/blob/main/libs/core/src/components/input/input.stories.ts) to see the full code for this example, as Storybook strips away property assignments in the code examples." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "Size", "declaration": { "name": "Size", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "Lead", "declaration": { "name": "Lead", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "Trail", "declaration": { "name": "Trail", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "Length", "declaration": { "name": "Length", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "Clearable", "declaration": { "name": "Clearable", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "SupportingText", "declaration": { "name": "SupportingText", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "ExtendedSupportingText", "declaration": { "name": "ExtendedSupportingText", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "Validation", "declaration": { "name": "Validation", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "StandardAttributes", "declaration": { "name": "StandardAttributes", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "Disabled", "declaration": { "name": "Disabled", "module": "src/components/input/input.stories.ts" } }, { "kind": "js", "name": "CustomCounterBadge", "declaration": { "name": "CustomCounterBadge", "module": "src/components/input/input.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/input/input.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` input::-webkit-outer-spin-button, input::-webkit-inner-spin-button { -webkit-appearance: var(--_appearance-spin-button, auto); } input[type='number'] { -moz-appearance: var(--_appearance-spin-button, textfield); } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/input/input.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/input/input.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/input/input.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/input/input.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/input/input.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsInput", "declaration": { "name": "GdsInput", "module": "src/components/input/input.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/link/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/link/link" } } ] }, { "kind": "javascript-module", "path": "src/components/link/link.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsLink", "slots": [ { "description": "Content to be displayed as the link string.", "name": "main" }, { "description": "An optional slot that allows a `gds-icon` element to be placed before the label.", "name": "lead" }, { "description": "An optional slot that allows a `gds-icon` element to be placed after the label.", "name": "trail" } ], "members": [ { "kind": "field", "name": "shadowRootOptions", "type": { "text": "ShadowRootInit" }, "static": true, "default": "{ mode: 'open', delegatesFocus: true, }" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Provides an accessible name for the link that will be read by screen readers.\nUse this when:\n- The link contains only an icon\n- The visual text needs a different description for screen readers\n- Additional context is needed for accessibility", "attribute": "label" }, { "kind": "field", "name": "'text-decoration'", "type": { "text": "string | undefined" }, "description": "Controls the text-decoration property of the link.\nSupports all valid CSS text-decoration values.\n\nSetting `text-decoration` on hover you can do it like this:\n```html\nUnderline on Hover\n```" }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "description": "URL that the link points to\nCan be absolute, relative, or fragment identifier", "attribute": "href", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Specifies where to open the linked document", "attribute": "target", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "description": "Specifies the relationship between the current document and the linked document\nAutomatically adds security-related values when target=\"_blank\"", "attribute": "rel", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "#rel", "privacy": "private", "type": { "text": "string | undefined" }, "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "download", "type": { "text": "string | boolean | undefined" }, "description": "When present, indicates that the linked resource should be downloaded", "attribute": "download", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "field", "name": "ping", "type": { "text": "string | undefined" }, "description": "Specifies a space-separated list of URLs to which, when the link is followed,\nPOST requests with the body ping will be sent by the browser.", "attribute": "ping", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when the link is clicked.", "name": "click" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Provides an accessible name for the link that will be read by screen readers.\nUse this when:\n- The link contains only an icon\n- The visual text needs a different description for screen readers\n- Additional context is needed for accessibility", "fieldName": "label" }, { "name": "href", "type": { "text": "string | undefined" }, "description": "URL that the link points to\nCan be absolute, relative, or fragment identifier", "fieldName": "href", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Specifies where to open the linked document", "fieldName": "target", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "Specifies the relationship between the current document and the linked document\nAutomatically adds security-related values when target=\"_blank\"", "fieldName": "rel", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "download", "type": { "text": "string | boolean | undefined" }, "description": "When present, indicates that the linked resource should be downloaded", "fieldName": "download", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "ping", "type": { "text": "string | undefined" }, "description": "Specifies a space-separated list of URLs to which, when the link is followed,\nPOST requests with the body ping will be sent by the browser.", "fieldName": "ping", "inheritedFrom": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLinkProps", "module": "/src/utils/mixins/props-link" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-link", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsLink", "declaration": { "name": "GdsLink", "module": "src/components/link/link.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/link/link.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Link', component: 'gds-link', parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-link'), }, }", "description": "A link navigates users to other pages or sections of content." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "Lead", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Icon: Lead', render: () => html` Link text `, }", "description": "A link component with a leading icon." }, { "kind": "variable", "name": "Trail", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Icon: Trail', render: () => html` Link text `, }", "description": "A link component with a trailing icon." }, { "kind": "variable", "name": "TextDecoration", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Text Decoration', render: () => html` Link with Underline Link text Link without Underline Link text Link with Underline on Hover and Icon Link text Link with No Underline on Hover Link text `, }", "description": "A link component has a `text-decoration` property that accepts all valid CSS `text-decoration` values.\n\nIt also supports setting `text-decoration` or disable on hover by using the `hover:` prefix.\n\n```html\n\n Underline on Hover\n\n```" }, { "kind": "variable", "name": "Label", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Label', render: () => html` Link with aria-label `, }", "description": "On the `gds-link` component, the `label` attribute is used to provide an accessible name for the link.\n\nIt will be forwarded to the `aria-label` attribute of the underlying anchor element.\n\n\nUse this when:\n- The link contains only an icon\n- The visual text needs a different description for screen readers\n- Additional context is needed for accessibility\n\n```html\n\n\n \n\n\n\n\n Read more\n\n```" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/link/link.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/link/link.stories.ts" } }, { "kind": "js", "name": "Lead", "declaration": { "name": "Lead", "module": "src/components/link/link.stories.ts" } }, { "kind": "js", "name": "Trail", "declaration": { "name": "Trail", "module": "src/components/link/link.stories.ts" } }, { "kind": "js", "name": "TextDecoration", "declaration": { "name": "TextDecoration", "module": "src/components/link/link.stories.ts" } }, { "kind": "js", "name": "Label", "declaration": { "name": "Label", "module": "src/components/link/link.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/link/link.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer core, link; @layer core { :host { display: inline-block; white-space: normal; } } @layer link { a { display: flex; align-items: center; gap: 1ch; text-decoration: none; text-underline-offset: 0.2lh; color: currentColor; cursor: pointer; border-radius: var(--gds-sys-radius-3xs); outline-offset: var(--gds-sys-space-3xs); outline-color: currentColor; font-weight: var(--gds-sys-text-weight-book); will-change: text-underline-offset; transition-property: text-underline-offset; transition-duration: var(--gds-sys-motion-duration-fastest); transition-timing-function: var(--gds-sys-motion-easing-ease-in-out); @media (pointer: fine) { &:hover { text-decoration: underline; text-underline-offset: 0.16lh; &:active { text-underline-offset: 0.08lh; } } } } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/link/link.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/link/link.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsLink", "declaration": { "name": "GdsLink", "module": "src/components/link/link.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/mask/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/mask/mask" } } ] }, { "kind": "javascript-module", "path": "src/components/mask/mask.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsMask", "members": [ { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'mask-image'", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "'mask-size'", "type": { "text": "string" }, "default": "'cover'" }, { "kind": "field", "name": "'mask-repeat'", "type": { "text": "string" }, "default": "'no-repeat'" }, { "kind": "field", "name": "'mask-position'", "type": { "text": "string" }, "default": "'center'" }, { "kind": "field", "name": "'backdrop-filter'", "type": { "text": "string | undefined" }, "description": "Controls the backdrop-filter property of the container.\nWhen you want to apply a backdrop blur filter to the container you can use this property.\n\n```html\n\n```\n\nThe above example will apply a backdrop blur filter of `20px`.\n\n The filter also support breakpoint syntax like this:\n\n```html\n\n```\n\nThe above example will apply the filter style of `20px` for `small` devices, `40px` for `medium` devices, and `60px` for large devices." }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" }, "default": "'relative'" }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" }, "default": "'flex'" }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" }, "default": "'0'" }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsFlex", "module": "/src/components/flex/flex.component" }, "tagName": "gds-mask", "customElement": true, "attributes": [ { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsMask", "declaration": { "name": "GdsMask", "module": "src/components/mask/mask.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/mask/mask.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Mask', component: 'gds-mask', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-mask'), }, }", "description": "The Mask component creates a gradient overlay effect that can be used to improve content visibility\nor create visual hierarchy. It's particularly useful when placing text over images or creating\nfade effects.\n\n\n### Basic Usage\n\nThe mask component is typically used in combination with images or videos to create gradient overlays:\n\n```html\n\n \n \n \n \n\n```\n\n### Common Use Cases\n\n1. Image Overlays:
    \n Create readable text over images by adding a gradient mask\n\n2. Content Fading:
    \n Add fade effects to content edges\n\n3. Visual Hierarchy:
    \n Draw attention to specific areas using gradient masks\n\n### Accessibility\n\nWhen using masks over content, ensure sufficient contrast for text readability.\nConsider using the dark theme for content within masks over light images.\n\n```html\n\n \n \n \n\n```" }, { "kind": "variable", "name": "Mask", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` Sustainability Actively supporting the net zero transition. Our impact `, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/mask/mask.stories.ts" } }, { "kind": "js", "name": "Mask", "declaration": { "name": "Mask", "module": "src/components/mask/mask.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/mask/mask.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { contain: strict; } [part='mask'] { position: absolute; inset: 0; z-index: -1; pointer-events: none; mask-composite: intersect; } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/mask/mask.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/mask/mask.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsMask", "declaration": { "name": "GdsMask", "module": "src/components/mask/mask.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/menu-button/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/menu-button/menu-button" } } ] }, { "kind": "javascript-module", "path": "src/components/menu-button/menu-button.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsMenuButton", "cssParts": [ { "description": "The main slot of the button, between the lead and trail slots.", "name": "main-slot" } ], "slots": [ { "description": "Content to be displayed as the button label.", "name": "" }, { "description": "An optional slot that allows a `gds-icon` element to be placed before the label.", "name": "lead" }, { "description": "An optional slot that allows a `gds-icon` element to be placed after the label.", "name": "trail" } ], "members": [ { "kind": "field", "name": "shadowRootOptions", "type": { "text": "ShadowRootInit" }, "static": true, "default": "{ mode: 'open', delegatesFocus: true, }" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the menu-button is disabled.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the menu-button. Use this to add an accessible label to the button when no text is provided in the default slot.", "attribute": "label" }, { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "When set, the underlying button will be rendered as an anchor element.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Where to display the linked URL. Only used when href is present.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked URL as space-separated link types. Only used when href is present. Defaults to \"noreferrer noopener\" for security reasons when target is set.", "attribute": "rel" }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "description": "Causes the browser to treat the linked URL as a download. Can be used with or without a filename value. Only used when href is present.", "attribute": "download" }, { "kind": "field", "name": "compact", "type": { "text": "boolean" }, "default": "false", "description": "The label of the menu-button. Use this to add an accessible label to the button when no text is provided in the default slot.", "attribute": "compact", "reflects": true }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the menu button is selected", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when the button is clicked.", "name": "click" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the menu-button is disabled.", "fieldName": "disabled" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the menu-button. Use this to add an accessible label to the button when no text is provided in the default slot.", "fieldName": "label" }, { "name": "href", "type": { "text": "string" }, "default": "''", "description": "When set, the underlying button will be rendered as an anchor element.", "fieldName": "href" }, { "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Where to display the linked URL. Only used when href is present.", "fieldName": "target" }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked URL as space-separated link types. Only used when href is present. Defaults to \"noreferrer noopener\" for security reasons when target is set.", "fieldName": "rel" }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Causes the browser to treat the linked URL as a download. Can be used with or without a filename value. Only used when href is present.", "fieldName": "download" }, { "name": "compact", "type": { "text": "boolean" }, "default": "false", "description": "The label of the menu-button. Use this to add an accessible label to the button when no text is provided in the default slot.", "fieldName": "compact" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the menu button is selected", "fieldName": "selected" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-menu-button", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsMenuButton", "declaration": { "name": "GdsMenuButton", "module": "src/components/menu-button/menu-button.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/menu-button/menu-button.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Menu button', component: 'gds-menu-button', parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-datepicker'), }, }", "description": "A menu button combines button and link behaviors for navigation menus." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "Selected_state", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html` Profile `, }", "description": "Selected state is used to indicate that the button is currently selected, for example to indicate the current page." }, { "kind": "variable", "name": "Only_text", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html`Search`, }", "description": "The menu button can be used without an icon as well." }, { "kind": "variable", "name": "Example_menu_bar", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html`
    Search
    Notification Profile
    Profile stuff
     External link     `, }", "description": "An example of a menu bar with a search button, a notification button, a profile button, and an external link button.\n\nThe profile buitton shows an example of using a popover together with a menu button.\n\nExternal link is an example of using a menu button as a link to a URL." }, { "kind": "variable", "name": "Compact_menu_bar", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html` Search Notification Profile
    Profile stuff
     External link     `, }", "description": "Same as above, but using the compact style. This is mainly intended for use in a mobile viewport." }, { "kind": "variable", "name": "Dark", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Dark Mode', render: () => html` Search Notification Profile
    Profile stuff
     External link     Search Notification Profile
    Profile stuff
     External link     `, }", "description": "Same as above, but using the compact style. This is mainly intended for use in a mobile viewport." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/menu-button/menu-button.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/menu-button/menu-button.stories.ts" } }, { "kind": "js", "name": "Selected_state", "declaration": { "name": "Selected_state", "module": "src/components/menu-button/menu-button.stories.ts" } }, { "kind": "js", "name": "Only_text", "declaration": { "name": "Only_text", "module": "src/components/menu-button/menu-button.stories.ts" } }, { "kind": "js", "name": "Example_menu_bar", "declaration": { "name": "Example_menu_bar", "module": "src/components/menu-button/menu-button.stories.ts" } }, { "kind": "js", "name": "Compact_menu_bar", "declaration": { "name": "Compact_menu_bar", "module": "src/components/menu-button/menu-button.stories.ts" } }, { "kind": "js", "name": "Dark", "declaration": { "name": "Dark", "module": "src/components/menu-button/menu-button.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/menu-button/menu-button.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer tokens, core, a11y, disabled, variants, sizes, sets; @layer tokens { :host { --_gap: var(--gds-sys-space-xs); --_padding-inline: var(--gds-sys-space-m); --_padding-block: var(--gds-sys-space-xs); --_color-bg: transparent; --_color-text: var(--gds-sys-color-content-neutral-01); --_color-border: transparent; --_font-size: 1rem; --_font-weight: 400; --_line-height: 1.25; display: inline-block; isolation: isolate; max-width: 100%; height: 100%; } } @layer core { .button { align-items: center; background-color: var(--_color-bg); border-bottom-width: 2px; border-style: none; border-color: var(--_color-border); border-bottom-style: solid; box-sizing: border-box; color-scheme: dark light; color: var(--_color-text); cursor: pointer; display: inline-flex; font-family: inherit; font-size: var(--_font-size); font-weight: var(--_font-weight); gap: var(--_gap); height: 100%; inline-size: 100%; justify-content: space-between; justify-items: center; line-height: var(--_line-height); outline-color: transparent; outline-offset: -2px; outline-style: solid; outline-width: 2px; padding-block: var(--_padding-block); padding-inline: var(--_padding-inline); position: relative; transition-property: color, border-color; transition: all var(--gds-sys-motion-duration-fastest); &:focus-visible { border-color: transparent; border-radius: 6px; outline-color: currentColor; overflow: visible; } &:hover, &.selected:hover, &:active { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-neutral-05) ); --_color-border: var(--gds-sys-color-border-neutral-01); } &.selected { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-neutral-06) ); --_color-border: var(--gds-sys-color-border-neutral-04); } slot:not([name]) { display: inline-block; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; } } .compact { display: flex; flex-direction: column; --_padding-inline: var(--gds-sys-space-s); --_gap: 1px; font-size: 0.875rem; height: 56px; justify-content: center; & > slot[name] { order: 0; } & > slot:not([name]) { order: 1; } @media (max-width: 576px) { font: var(--gds-sys-text-detail-book-xs); --_padding-inline: var(--gds-sys-space-xs); } } a { text-decoration: none; } } :disabled { border-color: var(--_color-bg); color: var(--gds-sys-color-content-disabled-01); pointer-events: none; } @layer a11y { @media (prefers-reduced-motion: reduce) { .button { transition: none; } } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/menu-button/menu-button.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/menu-button/menu-button.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsMenuButton", "declaration": { "name": "GdsMenuButton", "module": "src/components/menu-button/menu-button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/pagination/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/pagination/pagination" } } ] }, { "kind": "javascript-module", "path": "src/components/pagination/pagination.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsPagination", "members": [ { "kind": "field", "name": "page", "type": { "text": "number" }, "default": "1", "description": "Sets the active page, initially the first page.", "attribute": "page" }, { "kind": "field", "name": "rows", "type": { "text": "number" }, "default": "10", "description": "Sets the numbers of rows to show, defaults to 10", "attribute": "rows" }, { "kind": "field", "name": "total", "type": { "text": "number" }, "default": "0", "attribute": "total" }, { "kind": "field", "name": "options", "type": { "text": "array" }, "default": "[5, 10, 25, 50]", "description": "Options array to set the nunber of items per page.\nDefaults to `[5, 10, 25, 50]`", "attribute": "options" }, { "kind": "field", "name": "jump", "type": { "text": "boolean" }, "default": "false", "description": "Enables first and last button", "attribute": "jump" }, { "kind": "field", "name": "hideOptions", "type": { "text": "boolean" }, "default": "false", "description": "Hide options", "attribute": "hide-options" }, { "kind": "field", "name": "density", "type": { "text": "DensityMode" }, "default": "'comfortable'", "description": "Controls density mode on pagination\nAccepts: `comfortable`, `compact`, `spacious`", "attribute": "density" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The text summary to display on the left side (e.g. \"1-10 of 100\").\nIf a slot named \"label\" is provided, this property is ignored.", "attribute": "label" }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when the active page changes.", "name": "gds-page-change" }, { "description": "Fired when the rows per page value changes.", "name": "gds-rows-change" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "page", "type": { "text": "number" }, "default": "1", "description": "Sets the active page, initially the first page.", "fieldName": "page" }, { "name": "rows", "type": { "text": "number" }, "default": "10", "description": "Sets the numbers of rows to show, defaults to 10", "fieldName": "rows" }, { "name": "total", "type": { "text": "number" }, "default": "0", "fieldName": "total" }, { "name": "options", "type": { "text": "array" }, "default": "[5, 10, 25, 50]", "description": "Options array to set the nunber of items per page.\nDefaults to `[5, 10, 25, 50]`", "fieldName": "options" }, { "name": "jump", "type": { "text": "boolean" }, "default": "false", "description": "Enables first and last button", "fieldName": "jump" }, { "name": "hide-options", "type": { "text": "boolean" }, "default": "false", "description": "Hide options", "fieldName": "hideOptions" }, { "name": "density", "type": { "text": "DensityMode" }, "default": "'comfortable'", "description": "Controls density mode on pagination\nAccepts: `comfortable`, `compact`, `spacious`", "fieldName": "density" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The text summary to display on the left side (e.g. \"1-10 of 100\").\nIf a slot named \"label\" is provided, this property is ignored.", "fieldName": "label" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-pagination", "customElement": true, "summary": "A pagination component with page navigation, configurable rows per page, and responsive layout." } ], "exports": [ { "kind": "js", "name": "GdsPagination", "declaration": { "name": "GdsPagination", "module": "src/components/pagination/pagination.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/pagination/pagination.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Pagination', component: 'gds-pagination', tags: ['autodocs'], }" }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ args: { page: 1, rows: 10, total: 2000, options: [5, 10, 20, 50, 100], hideOptions: false, }, render: (args) => { const handlePageChange = (e: CustomEvent) => { args.page = e.detail.page document.querySelector('[data-page]')!.innerHTML = String(args.page) document .querySelector('[data-pagination]')! .setAttribute('page', String(args.page)) } const handleRowsChange = (e: CustomEvent) => { args.rows = e.detail.rows args.page = 1 document.querySelector('[data-rows]')!.innerHTML = String(args.rows) document.querySelector('[data-page]')!.innerHTML = '1' document.querySelector('[data-pagination]')!.setAttribute('page', '1') document .querySelector('[data-pagination]')! .setAttribute('rows', String(args.rows)) } return html` Page: ${args.page} Rows: ${args.rows} Total: ${args.total} ` }, }" }, { "kind": "variable", "name": "SingleOption", "type": { "text": "Story" }, "default": "{ args: { page: 1, rows: 8, total: 100, options: [8], hideOptions: false, label: '1-8 of 100', }, render: (args) => { const handlePageChange = (e: CustomEvent) => { args.page = e.detail.page document.querySelector('[data-page-single]')!.innerHTML = String( args.page, ) document .querySelector('[data-pagination-single]')! .setAttribute('page', String(args.page)) } const handleRowsChange = (e: CustomEvent) => { args.rows = e.detail.rows args.page = 1 document.querySelector('[data-rows-single]')!.innerHTML = String( args.rows, ) document.querySelector('[data-page-single]')!.innerHTML = '1' document .querySelector('[data-pagination-single]')! .setAttribute('page', '1') document .querySelector('[data-pagination-single]')! .setAttribute('rows', String(args.rows)) } return html` Page: ${args.page} Rows: ${args.rows} Total: ${args.total} ` }, }", "description": "When the options array contains only a single value, the page size selector\nis automatically hidden since there's no choice to make. This is useful when\nyou want a fixed page size without showing the selector UI." }, { "kind": "variable", "name": "OnePage", "type": { "text": "Story" }, "default": "{ args: { page: 1, rows: 10, total: 8, options: [5, 10, 20, 50, 100], hideOptions: false, label: '1-8 of 8', }, parameters: { docs: { description: { story: ` When all items fit on a single page (total ≤ rows), page navigation is hidden. If there are multiple page-size options, the rows-per-page selector remains visible so users can still switch to a smaller page size. `, }, }, }, render: (args) => { const handlePageChange = (e: CustomEvent) => { args.page = e.detail.page document.querySelector('[data-page-one]')!.innerHTML = String(args.page) document .querySelector('[data-pagination-one]')! .setAttribute('page', String(args.page)) } const handleRowsChange = (e: CustomEvent) => { args.rows = e.detail.rows args.page = 1 document.querySelector('[data-rows-one]')!.innerHTML = String(args.rows) document.querySelector('[data-page-one]')!.innerHTML = '1' document.querySelector('[data-pagination-one]')!.setAttribute('page', '1') document .querySelector('[data-pagination-one]')! .setAttribute('rows', String(args.rows)) } return html` Page: ${args.page} Rows: ${args.rows} Total: ${args.total} ` }, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/pagination/pagination.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/pagination/pagination.stories.ts" } }, { "kind": "js", "name": "SingleOption", "declaration": { "name": "SingleOption", "module": "src/components/pagination/pagination.stories.ts" } }, { "kind": "js", "name": "OnePage", "declaration": { "name": "OnePage", "module": "src/components/pagination/pagination.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/pagination/pagination.styles.ts", "declarations": [ { "kind": "variable", "name": "PaginationStyles", "default": "css` :host { display: flex; align-items: center; justify-content: center; gap: var(--gds-sys-space-xl); --_appearance-spin-button: none; } .navigation-controls ::part(_button) { padding: 0; aspect-ratio: 1/1; } `" } ], "exports": [ { "kind": "js", "name": "PaginationStyles", "declaration": { "name": "PaginationStyles", "module": "src/components/pagination/pagination.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/pagination/pagination.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsPagination", "declaration": { "name": "GdsPagination", "module": "src/components/pagination/pagination.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/popover/backdrop.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsBackdrop", "members": [ { "kind": "field", "name": "show", "type": { "text": "boolean" }, "default": "false", "attribute": "show", "reflects": true }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "show", "type": { "text": "boolean" }, "default": "false", "fieldName": "show" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-backdrop", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsBackdrop", "declaration": { "name": "GdsBackdrop", "module": "src/components/popover/backdrop.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/popover/backdrop.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsBackdrop", "declaration": { "name": "GdsBackdrop", "module": "src/components/popover/backdrop.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/popover/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/popover/popover" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/popover/backdrop" } } ] }, { "kind": "javascript-module", "path": "src/components/popover/popover.component.ts", "declarations": [ { "kind": "function", "name": "applyTriggerAriaAttributes", "parameters": [ { "name": "trigger", "type": { "text": "HTMLElement" } }, { "name": "open", "type": { "text": "boolean" } }, { "name": "popupRole", "type": { "text": "string" } } ], "description": "Apply the necessary ARIA attributes to a popover trigger element. Use this to apply correct\nattributes in advance if you render `` conditionally, since the popover component\nonly applies these attributes when it initializes." }, { "kind": "class", "description": "", "name": "GdsPopover", "slots": [ { "description": "Content of the popover", "name": "" }, { "description": "Trigger element for the popover. If this slot is occupied, the popover will listen to keydown and click events on the trigger and automtaiclly open when clicked or when the trigger is focused and `ArrowDown` is pressed.", "name": "trigger" } ], "members": [ { "kind": "field", "name": "DefaultMiddleware", "type": { "text": "Middleware[]" }, "static": true, "default": "[ offset(8), shift({ crossAxis: true, padding: 8, }), ]", "description": "The default set of middleware for Floating UI positioning used by GdsPopover." }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the popover is open.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "popupRole", "type": { "text": "'menu' | 'listbox' | 'tree' | 'grid' | 'dialog'" }, "default": "'dialog'", "description": "This is used to indicate the semantic role of the popover. This will set the `aria-haspopup` attribute on the trigger element.\nRead here for more information: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-haspopup", "attribute": "popup-role" }, { "kind": "field", "name": "triggerRef", "type": { "text": "Promise | undefined" }, "description": "Optional way to assign a trigger element for the popover. When using Lit, this can take a value from a `@queryAsync` decorator in order to set the trigger element programatically." }, { "kind": "field", "name": "anchorRef", "type": { "text": "Promise | undefined" }, "description": "Optional way to assign an anchor element for the popover. When using Lit, this can take a value from a `@queryAsync` decorator in order to set the anchor element programatically." }, { "kind": "field", "name": "label", "type": { "text": "string | undefined" }, "default": "undefined", "description": "Optional trigger element for the popover.", "attribute": "label" }, { "kind": "field", "name": "placement", "type": { "text": "Placement" }, "default": "'bottom-start'", "description": "The placement of the popover relative to the trigger.\nAccepts any of the placements supported by Floating UI.", "attribute": "placement" }, { "kind": "field", "name": "disableMobileStyles", "type": { "text": "boolean" }, "default": "false", "description": "Whether to use a modal dialog in mobile viewport.", "attribute": "disableMobileStyles" }, { "kind": "field", "name": "disableScrollClose", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable closing the popover when the page is scrolled.", "attribute": "disableScrollClose" }, { "kind": "field", "name": "autofocus", "type": { "text": "boolean" }, "default": "false", "description": "Whether the popover should autofocus the first slotted child when opened.", "attribute": "autofocus" }, { "kind": "field", "name": "calcMinWidth", "description": "A callback that returns the minimum width of the popover.\nBy default, the popover minWidth will be as wide as the trigger element." }, { "kind": "field", "name": "calcMaxWidth", "description": "A callback that returns the maximum width of the popover.\nBy default, the popover maxWidth will be set to `auto` and will grow as needed." }, { "kind": "field", "name": "calcMinHeight", "description": "A callback that returns the minimum height of the popover.\nBy default, the popover minHeight will be set to `auto`" }, { "kind": "field", "name": "calcMaxHeight", "description": "A callback that returns the maximum height of the popover.\nBy default, the popover maxHeight will be set to a hard coded pixel value (check source code)." }, { "kind": "field", "name": "nonmodal", "type": { "text": "boolean" }, "default": "false", "description": "Whether the popover is nonmodal. When true, the popover will not trap focus and other elements\non the page will still be interactable while the popover is open.", "attribute": "nonmodal", "reflects": true }, { "kind": "field", "name": "backdrop", "type": { "text": "string | undefined" }, "description": "When this is set to `true`, the `:backdrop` pseudo-element will be visible if the popover is\nin modal mode. When not in modal mode (using the `nonmodal` attribute), this can instead be\nset to a selector matching a `` element, in wich case the popover will take\ncontrol of that backdrop.\n\nExample:\n```html\n\n Open\n

    Popover content

    \n    \n\n```", "attribute": "backdrop" }, { "kind": "field", "name": "floatingUIMiddleware", "type": { "text": "Middleware[]" }, "description": "An array of middleware for the Floating UI positioning algorithm. Here you can pass in an array\nof middleware to customize positioning to your needs. This array is passed directly to Floting UI,\nso you can just follow the documentation here: https://floating-ui.com/docs/middleware\n\nThis property does not have a corresponding attribute, so it can only be set in JavaScript.\n\nDefaults to `[offset(8), flip()]`" }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when the popover is opened or closed. Can be cancelled to prevent the popover from opening or closing. The `detail` object contains the `open` boolean to indicate the result of the state change, and the `reason` string which can be one of `show`, `close`, or `cancel`.", "name": "gds-ui-state" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the popover is open.", "fieldName": "open" }, { "name": "popup-role", "type": { "text": "'menu' | 'listbox' | 'tree' | 'grid' | 'dialog'" }, "default": "'dialog'", "description": "This is used to indicate the semantic role of the popover. This will set the `aria-haspopup` attribute on the trigger element.\nRead here for more information: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-haspopup", "fieldName": "popupRole" }, { "name": "label", "type": { "text": "string | undefined" }, "default": "undefined", "description": "Optional trigger element for the popover.", "fieldName": "label" }, { "name": "placement", "type": { "text": "Placement" }, "default": "'bottom-start'", "description": "The placement of the popover relative to the trigger.\nAccepts any of the placements supported by Floating UI.", "fieldName": "placement" }, { "name": "disableMobileStyles", "type": { "text": "boolean" }, "default": "false", "description": "Whether to use a modal dialog in mobile viewport.", "fieldName": "disableMobileStyles" }, { "name": "disableScrollClose", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable closing the popover when the page is scrolled.", "fieldName": "disableScrollClose" }, { "name": "autofocus", "type": { "text": "boolean" }, "default": "false", "description": "Whether the popover should autofocus the first slotted child when opened.", "fieldName": "autofocus" }, { "name": "nonmodal", "type": { "text": "boolean" }, "default": "false", "description": "Whether the popover is nonmodal. When true, the popover will not trap focus and other elements\non the page will still be interactable while the popover is open.", "fieldName": "nonmodal" }, { "name": "backdrop", "type": { "text": "string | undefined" }, "description": "When this is set to `true`, the `:backdrop` pseudo-element will be visible if the popover is\nin modal mode. When not in modal mode (using the `nonmodal` attribute), this can instead be\nset to a selector matching a `` element, in wich case the popover will take\ncontrol of that backdrop.\n\nExample:\n```html\n\n Open\n

    Popover content

    \n    \n\n```", "fieldName": "backdrop" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-popover", "customElement": true } ], "exports": [ { "kind": "js", "name": "applyTriggerAriaAttributes", "declaration": { "name": "applyTriggerAriaAttributes", "module": "src/components/popover/popover.component.ts" } }, { "kind": "js", "name": "GdsPopover", "declaration": { "name": "GdsPopover", "module": "src/components/popover/popover.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/popover/popover.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Popover', component: 'gds-popover', parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-popover'), }, }", "description": "A popover is a temporary view that appears above other content." }, { "kind": "variable", "name": "Usage", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }", "description": "The popover can be used declaratively by adding a trigger button and content inside the popover element, like in the example below.\n\nIt is also possible to set the trigger and anchor by supplying DOM references (wrapped in promises) to the `triggerRef` and `anchorRef`\nproperties. This is useful when the trigger and anchor needs to be different elements." }, { "kind": "variable", "name": "CancelEvent", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html` e.detail.reason === 'close' && e.preventDefault()} > Show popover

    Customized closing behavior

    This popover can only be closed by click the button below or hitting escape.

    { ;(document.getElementById('cancellable') as GdsPopover).open = false }} >Close me!
    `, }", "description": "By default, the popover will close when clicking outside or hitting the escape key. This behavior can be customized by listening to the `gds-ui-state` event and calling `preventDefault()` on the event object when the popover should not close.\n\nFor example:\n\n```html\n html` Open popover This popover will stay open when you scroll the page! `, }", "description": "By default, the popover closes when the page is scrolled (on desktop viewports wider than 767px).\nThis behavior can be disabled by setting the `disableScrollClose` property to `true`." }, { "kind": "variable", "name": "Customization", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: () => html` Basic popover
    Basic popover
     ({ x: 25, y: y + 8 }) }]} .calcMaxWidth=${() => '670px'}> With custom backdrop and positioning middleware

    Customized popover

    In this popover, we're using custom Floating UI middleware to control the positioning, and calcMaxWidth to set the size.

    We're also using a backdrop element, referenced by the backdrop attribute, to dim the background below the menu bar.

         `, }", "description": "Here is an example of how the popover can be customized with sizing, placement and backdrop." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/popover/popover.stories.ts" } }, { "kind": "js", "name": "Usage", "declaration": { "name": "Usage", "module": "src/components/popover/popover.stories.ts" } }, { "kind": "js", "name": "CancelEvent", "declaration": { "name": "CancelEvent", "module": "src/components/popover/popover.stories.ts" } }, { "kind": "js", "name": "DisableScrollClose", "declaration": { "name": "DisableScrollClose", "module": "src/components/popover/popover.stories.ts" } }, { "kind": "js", "name": "Customization", "declaration": { "name": "Customization", "module": "src/components/popover/popover.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/popover/popover.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset, transitional-styles; @layer base { :host { display: contents; } :host > div:not([hidden]) { display: contents; } :host([open]) dialog { opacity: 1; box-sizing: border-box; visibility: visible; } dialog { display: flex; flex-direction: column; inset: auto; position: fixed; overflow: hidden; padding: 0px; box-sizing: border-box; right: 0; margin: 0; box-shadow: var(--gds-sys-shadow-l-01); border: var(--gds-sys-space-5xs) solid var(--gds-sys-color-border-neutral-02); border-radius: var(--gds-sys-radius-s); overscroll-behavior: contain; } :host([nonmodal]) dialog { z-index: 1; } @media (max-width: 576px) { dialog.use-modal-in-mobile { border-radius: var(--gds-sys-radius-m) var(--gds-sys-radius-m) 0 0; transition: transform var(--gds-sys-motion-duration-fastest) ease; min-width: 100vw; position: fixed; bottom: 0; left: 0; padding-bottom: 0; transform: translateY(0); @starting-style { transform: translateY(100%); } &::backdrop { background-color: rgba(0, 0, 0, 0.3); display: block; position: fixed; opacity: 1; transition: opacity var(--gds-sys-motion-duration-fast) ease; @starting-style { opacity: 0; } } } } @media (min-width: 577px) { header { display: none; } } header { display: none; } @media (min-width: 577px) { dialog:not(.has-backdrop)::backdrop { background-color: transparent; display: block; position: fixed; } } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/popover/popover.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/popover/popover.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/popover/popover.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/popover/popover.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/popover/popover.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsPopover", "declaration": { "name": "GdsPopover", "module": "src/components/popover/popover.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/radio/radio" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/radio/radio-group/radio-group" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/radio.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsRadio", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label displayed next to the radio button.", "attribute": "label" }, { "kind": "field", "name": "supportingText", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed below the label.\nThis text provides additional context or information to the user.", "attribute": "supporting-text" }, { "kind": "field", "name": "value", "type": { "text": "string | boolean" }, "default": "''", "description": "The value of the radio button.", "attribute": "value" }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the radio button is checked or not.", "attribute": "checked", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the radio button is disabled or not.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "default": "false", "description": "Whether the radio button is invalid or not.", "attribute": "invalid" }, { "kind": "field", "name": "errorMessage", "type": { "text": "string | undefined" }, "description": "The accessible error message text for the radio button.\n\nThis text is not visually rendered, but will be announced by\nscreen readers when the radio button is in an invalid state.", "attribute": "errorMessage" }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Dispatched when the radio button is checked.", "name": "input" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label displayed next to the radio button.", "fieldName": "label" }, { "name": "supporting-text", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed below the label.\nThis text provides additional context or information to the user.", "fieldName": "supportingText" }, { "name": "value", "type": { "text": "string | boolean" }, "default": "''", "description": "The value of the radio button.", "fieldName": "value" }, { "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the radio button is checked or not.", "fieldName": "checked" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the radio button is disabled or not.", "fieldName": "disabled" }, { "name": "invalid", "type": { "text": "boolean" }, "default": "false", "description": "Whether the radio button is invalid or not.", "fieldName": "invalid" }, { "name": "errorMessage", "type": { "text": "string | undefined" }, "description": "The accessible error message text for the radio button.\n\nThis text is not visually rendered, but will be announced by\nscreen readers when the radio button is in an invalid state.", "fieldName": "errorMessage" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-radio", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsRadio", "declaration": { "name": "GdsRadio", "module": "src/components/radio/radio.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/radio.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Radio', component: 'gds-radio-group', subcomponents: { GdsRadio: 'gds-radio' }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-radio-group'), }, }", "description": "A radio button is a form element that allows users to select one of the predefined set of choices.
    \nThey are grouped using a radio group component which manages selection, keyboard navigation, and validation.\n\nGroups support vertical and horizontal layouts, and can be sized to fit different space requirements." }, { "kind": "variable", "name": "RadioButton", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Radio', args: { label: 'Pick an option', supportingText: 'Label support text.', innerHTML: ` `, }, }", "description": "Radio buttons allow users to select a single option from a list of two or more mutually exclusive options.
    \nEach radio button must have both a label and a value.\n\nUsage:\n\n```html\n\n \n \n\n```\n\nInteractive example with supporting texts:" }, { "kind": "variable", "name": "Validation", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Validation', render: () => html`
    { if (!el.value) return [ { ...el.validity, valid: false, customError: true }, 'This is required', ] }, }} > Extended supporting text for the group Submit
    `, }", "description": "Radio groups support validation using Green Core's [form validation API](/docs/components-form-validation-documentation--docs).\n\nThe error message appears below the radio group, and can be set either trough a validator, or explicctly using the using the `error-message` attribute.\n\nIf you click on 'submit' first on the example below it will validate the radio group and show the error message." }, { "kind": "variable", "name": "DosAndDonts", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: \"Do's and don'ts\", render: () => html` Do provide both Label and Value Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Never exclude the label
    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
    Never exclude the value
    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
    `, }" }, { "kind": "variable", "name": "Disabled", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Disabled', render: () => html`
    Extended supporting text for the group
    `, }", "description": "Disabled radio buttons cannot be interacted with and appear visually muted.\n\nIn general, this state should never be used. Instead, aim to explain to the user why the choice is wrong in an error message and make sure they understand how to correct it." }, { "kind": "variable", "name": "Size", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Size', render: () => html`
    Size: Large(default) Extended supporting text for the group Size: small Extended supporting text for the group
    `, }", "description": "Radio buttons support two sizes:\n- Large (default): Standard size for most use cases\n- Small: Compact size for space-constrained layouts\n\nThe size can be set on the radio group and applies to all radio buttons within." }, { "kind": "variable", "name": "Direction", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Direction', render: () => html`
    Column (default) Extended supporting text for the group Row Extended supporting text for the group
    `, }", "description": "Radio buttons can be arranged in two directions:\n- Column (default): Vertical stacking for clear separation\n- Row: Horizontal alignment for compact layouts that will break to new line when not enough space is available\n\nChoose the direction based on available space and number of options." }, { "kind": "variable", "name": "GroupLabel", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Radio group label', render: () => html`
    `, }", "description": "While radio groups can be created without a label, it's recommended to always provide one for clarity and accessibility.\nThe label helps users understand what the options are for.\n\nIn certain cases when space is limited, the group label can be omitted." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/radio/radio.stories.ts" } }, { "kind": "js", "name": "RadioButton", "declaration": { "name": "RadioButton", "module": "src/components/radio/radio.stories.ts" } }, { "kind": "js", "name": "Validation", "declaration": { "name": "Validation", "module": "src/components/radio/radio.stories.ts" } }, { "kind": "js", "name": "DosAndDonts", "declaration": { "name": "DosAndDonts", "module": "src/components/radio/radio.stories.ts" } }, { "kind": "js", "name": "Disabled", "declaration": { "name": "Disabled", "module": "src/components/radio/radio.stories.ts" } }, { "kind": "js", "name": "Size", "declaration": { "name": "Size", "module": "src/components/radio/radio.stories.ts" } }, { "kind": "js", "name": "Direction", "declaration": { "name": "Direction", "module": "src/components/radio/radio.stories.ts" } }, { "kind": "js", "name": "GroupLabel", "declaration": { "name": "GroupLabel", "module": "src/components/radio/radio.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/radio.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { cursor: pointer; } :host([disabled]) { color: var(--gds-sys-color-content-disabled-01); cursor: default; } :host(:focus) { outline: none; } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/radio/radio.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/radio.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsRadio", "declaration": { "name": "GdsRadio", "module": "src/components/radio/radio.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/rich-text/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/rich-text/rich-text" } } ] }, { "kind": "javascript-module", "path": "src/components/rich-text/rich-text.component.ts", "declarations": [ { "kind": "class", "description": "`gds-rich-text` can be used to wrap generic HTML content and apply typography styles.\n\nThe wrapped content will render inside the shadowRoot of the `gds-rich-text` element, thereby applying the\ndefault typography styles and standard element styles defined in the Green Design System.", "name": "GdsRichText", "members": [ { "kind": "field", "name": "captureMode", "type": { "text": "'clone' | 'move'" }, "default": "'clone'", "description": "Capture mode for the content.\n\n- `clone` (default): Clones the content to the shadowRoot.\\\n This is the default and most compatible behaviour, since it leaves the original DOM untouched.\n the downside is that events added through `addEventListener` will not be retained in the cloned DOM.\n\n- `move`: Moves the content to the inner shadowRoot.\\\n This mode moves the full original sub-tree into the shadowRoot, leaving everything, including event\n listeners, intact.\n This mode is less compatible with some libraries that rely on the original DOM structure, for example React", "attribute": "captureMode" }, { "kind": "method", "name": "querySelectorAll", "return": { "type": { "text": "NodeList" } }, "parameters": [ { "name": "selector", "type": { "text": "string" } } ], "description": "Forwards the selector to the corresponding function on the inner shadowRoot." }, { "kind": "method", "name": "querySelector", "return": { "type": { "text": "Element | null" } }, "parameters": [ { "name": "selector", "type": { "text": "string" } } ], "description": "Forwards the selector to the corresponding function on the inner shadowRoot." }, { "kind": "field", "name": "innerHTML", "type": { "text": "string" }, "description": "Forwards innerHTML from the inner shadowRoot." }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "captureMode", "type": { "text": "'clone' | 'move'" }, "default": "'clone'", "description": "Capture mode for the content.\n\n- `clone` (default): Clones the content to the shadowRoot.\\\n This is the default and most compatible behaviour, since it leaves the original DOM untouched.\n the downside is that events added through `addEventListener` will not be retained in the cloned DOM.\n\n- `move`: Moves the content to the inner shadowRoot.\\\n This mode moves the full original sub-tree into the shadowRoot, leaving everything, including event\n listeners, intact.\n This mode is less compatible with some libraries that rely on the original DOM structure, for example React", "fieldName": "captureMode" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-rich-text", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsRichText", "declaration": { "name": "GdsRichText", "module": "src/components/rich-text/rich-text.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/rich-text/rich-text.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Rich Text', component: 'gds-rich-text', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-rich-text'), }, }", "description": "`gds-rich-text` can be used to wrap generic HTML content and apply typography styles.\n\nThe wrapped content will get captured and transferred to the inner shadowRoot of the `gds-rich-text` element.\n\nA typical use case for this component is to wrap a block of HTML content output from a CMS or other source\nthat you want to apply the design system typography to.\n\nIt supports out of the box all heading styles, paragraphs, lists, blockquotes, figures, tables, and more." }, { "kind": "variable", "name": "Card", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Card', render: (args) => html`

    The Starship SS Endeavor Exploration Class

    Heading one

    Heading test

    The SS Endeavor is a state-of-the-art exploration class starship designed for deep space missions. Equipped with advanced technology and robust systems, it aims to expand our understanding of the universe. With a focus on interstellar travel, the SS Endeavor features a unique propulsion system that allows for faster-than-light travel. Its mission is to explore uncharted territories and gather data on distant celestial bodies. Link

    \"SS
    Artist's rendition of the SS Endeavor in flight.

    \"The SS Endeavor represents the pinnacle of human engineering and ambition. It is not just a vessel; it is our gateway to the stars.\" — Dr. Amelia Carter, Chief Engineer

    For detailed specifications, please refer to the technical documentation. The SS Endeavor is equipped with cutting-edge systems that ensure the safety and efficiency of its crew during long-duration missions.

    Furthermore, SS Endeavor is designed with a modular approach, allowing for easy upgrades and maintenance.

    Specifications

    • Length: 150 meters Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
    • Width: 50 meters
    • Height: 30 meters
    • Crew Capacity: 100 personnel
    • Propulsion: Quantum Slipstream Drive
    • Maximum Speed: 10 light-years per hour

    One digit list

    1. Conduct scientific research on exoplanets, focusing on atmospheric composition Inline link and potential habitability.
    2. Establish contact with potential extraterrestrial civilizations through advanced signal detection and transmission protocols.
    3. Collect comprehensive data on diverse cosmic phenomena, including black hole dynamics, supernova remnants, and dark matter distribution.
    4. Test new technologies in real-world scenarios, specifically advanced propulsion systems for interstellar travel.
    5. Test new technologies in real-world scenarios, implementing closed-loop life support systems for long-duration space missions.

    Two digit list

    1. Conduct scientific research on exoplanets, focusing on atmospheric composition Inline link and potential habitability.
    2. Establish contact with potential extraterrestrial civilizations through advanced signal detection and transmission protocols.
    3. Collect comprehensive data on diverse cosmic phenomena, including black hole dynamics, supernova remnants, and dark matter distribution.
    4. Test new technologies in real-world scenarios, specifically advanced propulsion systems for interstellar travel.
    5. Test new technologies in real-world scenarios, implementing closed-loop life support systems for long-duration space missions.
    6. Test new technologies in real-world scenarios, evaluating the effectiveness of advanced radiation shielding materials.
    7. Test new technologies in real-world scenarios, deploying autonomous robotic systems for deep-space exploration and resource extraction.
    8. Test new technologies in real-world scenarios, analyzing the performance of quantum communication networks in space.
    9. Test new technologies in real-world scenarios, using advanced AI for real time data analysis and decision making.
    10. Investigate the origins and evolution of the universe through high-resolution astronomical observations.
    11. Develop and deploy advanced sensor arrays for detecting gravitational waves and other subtle cosmic signals.
    12. Analyze asteroid compositions to understand the early solar system and potential resources.
    13. Map the galactic structure with unprecedented accuracy, revealing hidden star systems and nebula.
    14. Study the effects of prolonged space travel on human physiology and psychology, preparing for future interstellar journeys.
    15. Create detailed models of planetary formation and evolution, improving our understanding of planet diversity.
    16. Explore the possibility of utilizing advanced energy sources, like fusion reactors, for deep space exploration.

    Research Areas

    Focus Areas

    The SS Endeavor will focus on the following research areas:

    • Astrobiology
    • Exoplanetary geology
    • Astrophysics and cosmology
    • Space weather and its effects on technology
    Exploration Objectives

    The SS Endeavor aims to achieve significant breakthroughs in the following exploration objectives:

    • Mapping the surface of Mars for potential human colonization
    • Studying the atmospheres of gas giants
    • Investigating the potential for life on Europa
    • Understanding the dynamics of asteroid belts
    Technological Innovations

    The SS Endeavor will develop and implement cutting-edge technologies in these areas:

    • Advanced propulsion systems for deep space travel
    • Autonomous robotic systems for planetary exploration
    • Next-generation communication systems for interstellar data transmission
    • Innovative life support systems for long-duration missions

    In summary, the SS Endeavor is poised to lead humanity's next great leap into the cosmos. With the right investments and support, its missions will pave the way for future exploration and discovery. Join us as we embark on this exciting journey into the unknown.

    Component Details Function
    Life Support System Advanced recycling and oxygen generation Ensures crew survival during long missions
    Navigation System AI-assisted star mapping Guides the ship through uncharted space
    Defensive Systems Energy shields and hull plating Protects against cosmic threats
    Scientific Labs Equipped for various research disciplines Facilitates on-board experiments
    Propulsion System Quantum Slipstream Drive Enables faster-than-light travel

    Iframe

         `, }" }, { "kind": "variable", "name": "Headings", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Headings', render: (args) => html`

    Heading 1

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Heading 2

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Heading 3

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Heading 4

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Heading 5

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Heading 6

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

    `, }", "description": "`gds-rich-text` can be used to wrap generic HTML content and apply typography styles.\nIt supports out of the box all heading styles from h1 to h6 based on the green design system typography styles." }, { "kind": "variable", "name": "Lists", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Lists', render: (args) => html`

    Key Technologies in Space Exploration

    • Rocket propulsion systems
    • Life support systems
    • Communication satellites
    • Space habitats and modules
    • Robotic exploration rovers
    • Advanced materials for spacecraft

    Major Milestones in Space Exploration

    1. Launch of Sputnik 1 (1957) - The first artificial satellite.
    2. First human in space (Yuri Gagarin, 1961) - Historic manned spaceflight.
    3. Apollo 11 Moon landing (1969) - First humans to walk on the Moon.
    4. Launch of the Space Shuttle (1981) - Introduction of reusable spacecraft.
    5. Mars Rover Curiosity landing (2012) - Advanced exploration of the Martian surface.
    6. Launch of the James Webb Space Telescope (2021) - Next-generation space observatory.
    `, }", "description": "`gds-rich-text` has built-in support for ordered and unordered lists.\nIt applies consistent spacing and typography styles to list items." }, { "kind": "variable", "name": "Details", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Details', render: (args) => html`

    Research Areas

    Focus Areas

    The SS Endeavor will focus on the following research areas:

    • Astrobiology
    • Exoplanetary geology
    • Astrophysics and cosmology
    • Space weather and its effects on technology
    Exploration Objectives

    The SS Endeavor aims to achieve significant breakthroughs in the following exploration objectives:

    • Mapping the surface of Mars for potential human colonization
    • Studying the atmospheres of gas giants
    • Investigating the potential for life on Europa
    • Understanding the dynamics of asteroid belts
    Technological Innovations

    The SS Endeavor will develop and implement cutting-edge technologies in these areas:

    • Advanced propulsion systems for deep space travel
    • Autonomous robotic systems for planetary exploration
    • Next-generation communication systems for interstellar data transmission
    • Innovative life support systems for long-duration missions
     `, }", "description": "`gds-rich-text` has built-in support for details html element.\n\nThe details element is a disclosure widget from HTML5 that can be used to hide or show additional content." }, { "kind": "variable", "name": "Blockquote", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Blockquote', render: (args) => html`

    Inspirational Quotes from Space Exploration Pioneers

    \"That's one small step for [a] man, one giant leap for mankind.\" — Neil Armstrong, Apollo 11 Astronaut

    \"The important achievement of Apollo was demonstrating that humanity is not forever chained to this planet and our visions go rather further than that and our opportunities are unlimited.\" — Neil Armstrong

    \"To confine our attention to terrestrial matters would be to limit the human spirit.\" — Stephen Hawking, Theoretical Physicist

    \"The Earth is the cradle of humanity, but mankind cannot stay in the cradle forever.\" — Konstantin Tsiolkovsky, Rocket Scientist

    \"I don't want to be an astronaut. I want to be a space explorer.\" — Chris Hadfield, Astronaut

    `, }", "description": "`gds-rich-text` has built-in support blockquote element." }, { "kind": "variable", "name": "Formatting", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Formatting', render: (args) => html`

    Key Concepts in Space Exploration

    The field of space exploration is constantly evolving. It is essential to understand the fundamental principles that guide our missions. For example, propulsion technology is crucial for successful space travel. Moreover, the study of black holes has revealed significant insights into the nature of the universe.

    As we continue to explore the cosmos, collaboration among international space agencies is vital. Together, we can achieve greater advancements in our understanding of the universe.

    `, }", "description": "`gds-rich-text` has built-in support for inline formatting tags such as `s`, `mark`, `strong`,`small` and `em`." }, { "kind": "variable", "name": "Table", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Table', render: (args) => html`

    Significant Space Missions

    Mission Name Launch Objectives Outcomes
    Apollo 11 1969 First manned Moon landing Successful lunar landing; Neil Armstrong and Buzz Aldrin walked on the Moon.
    Voyager 1 1977 Explore outer planets and interstellar space Provided detailed images of Jupiter and Saturn; currently in interstellar space.
    Hubble Space Telescope 1990 Observe distant galaxies and cosmic phenomena Revolutionized astronomy; provided stunning images and data.
    Curiosity Rover 2011 Explore Mars' surface and assess habitability Confirmed the presence of water; conducted extensive geological analysis.
    James Webb Space Telescope 2021 Observe the early universe and exoplanets Expected to provide unprecedented insights into the cosmos.
    `, }", "description": "`gds-rich-text` has built-in support for tables." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Theme', render: (args) => html`

    The Starship SS Endeavor Exploration Class

    Heading one

    Heading test

    The SS Endeavor is a state-of-the-art exploration class starship designed for deep space missions. Equipped with advanced technology and robust systems, it aims to expand our understanding of the universe. With a focus on interstellar travel, the SS Endeavor features a unique propulsion system that allows for faster-than-light travel. Its mission is to explore uncharted territories and gather data on distant celestial bodies. Link

    \"SS
    Artist's rendition of the SS Endeavor in flight.

    \"The SS Endeavor represents the pinnacle of human engineering and ambition. It is not just a vessel; it is our gateway to the stars.\" — Dr. Amelia Carter, Chief Engineer

    For detailed specifications, please refer to the technical documentation. The SS Endeavor is equipped with cutting-edge systems that ensure the safety and efficiency of its crew during long-duration missions.

    Furthermore, SS Endeavor is designed with a modular approach, allowing for easy upgrades and maintenance.

    Specifications

    • Length: 150 meters Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
    • Width: 50 meters
    • Height: 30 meters
    • Crew Capacity: 100 personnel
    • Propulsion: Quantum Slipstream Drive
    • Maximum Speed: 10 light-years per hour

    Mission Objectives

    1. Conduct scientific research on exoplanets.
    2. Establish contact with potential extraterrestrial civilizations.
    3. Collect data on cosmic phenomena.
    4. Test new technologies in real-world scenarios.

    Research Areas

    Focus Areas

    The SS Endeavor will focus on the following research areas:

    • Astrobiology
    • Exoplanetary geology
    • Astrophysics and cosmology
    • Space weather and its effects on technology
    Exploration Objectives

    The SS Endeavor aims to achieve significant breakthroughs in the following exploration objectives:

    • Mapping the surface of Mars for potential human colonization
    • Studying the atmospheres of gas giants
    • Investigating the potential for life on Europa
    • Understanding the dynamics of asteroid belts
    Technological Innovations

    The SS Endeavor will develop and implement cutting-edge technologies in these areas:

    • Advanced propulsion systems for deep space travel
    • Autonomous robotic systems for planetary exploration
    • Next-generation communication systems for interstellar data transmission
    • Innovative life support systems for long-duration missions

    In summary, the SS Endeavor is poised to lead humanity's next great leap into the cosmos. With the right investments and support, its missions will pave the way for future exploration and discovery. Join us as we embark on this exciting journey into the unknown.

    Component Details Function
    Life Support System Advanced recycling and oxygen generation Ensures crew survival during long missions
    Navigation System AI-assisted star mapping Guides the ship through uncharted space
    Defensive Systems Energy shields and hull plating Protects against cosmic threats
    Scientific Labs Equipped for various research disciplines Facilitates on-board experiments
    Propulsion System Quantum Slipstream Drive Enables faster-than-light travel

    Iframe

         `, }", "description": "Rich text can be used with other components to create engaging content.\nIn this example, we combine rich text with a card component to showcase how colors will be applied.\n\nExample:\n\n```html\n\n \n ...\n \n\n```" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/rich-text/rich-text.stories.ts" } }, { "kind": "js", "name": "Card", "declaration": { "name": "Card", "module": "src/components/rich-text/rich-text.stories.ts" } }, { "kind": "js", "name": "Headings", "declaration": { "name": "Headings", "module": "src/components/rich-text/rich-text.stories.ts" } }, { "kind": "js", "name": "Lists", "declaration": { "name": "Lists", "module": "src/components/rich-text/rich-text.stories.ts" } }, { "kind": "js", "name": "Details", "declaration": { "name": "Details", "module": "src/components/rich-text/rich-text.stories.ts" } }, { "kind": "js", "name": "Blockquote", "declaration": { "name": "Blockquote", "module": "src/components/rich-text/rich-text.stories.ts" } }, { "kind": "js", "name": "Formatting", "declaration": { "name": "Formatting", "module": "src/components/rich-text/rich-text.stories.ts" } }, { "kind": "js", "name": "Table", "declaration": { "name": "Table", "module": "src/components/rich-text/rich-text.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/rich-text/rich-text.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/rich-text/rich-text.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { font: var(--gds-sys-text-body-m-regular); --default-border: 1px solid color-mix(in srgb, currentColor, transparent 80%); letter-spacing: 0.0125rem; display: block; } h1, h2, h3, h4, h5, h6 { margin-top: var(--gds-sys-space-2xl); margin-bottom: var(--gds-sys-space-xs); } :is(h1, h2, h3, h4, h5, h6):first-child { margin-top: unset; } h1 + h2 { margin-top: 0; } h2 + h3 { margin-top: 0; } h3 + h4 { margin-top: 0; } h4 + h5 { margin-top: 0; } h4 + h5 { margin-top: 0; } h5 + h6 { margin-top: 0; } p { margin: 0; margin-bottom: var(--gds-sys-space-m); max-width: 80ch; } blockquote { margin: unset; margin-block: 2lh; border-left: 0.2rem solid currentColor; padding-left: 2ch; max-width: 40ch; } code { background: var(--gds-sys-color-l3-neutral-02); color: var(--gds-sys-color-content-neutral-01); border-radius: var(--gds-sys-radius-xs); padding: var(--gds-sys-space-3xs); font: var(--gds-sys-text-body-s-book); } hr { border: none; border-top: var(--default-border); margin: var(--gds-sys-space-xl) 0; } s { text-decoration: underline; text-decoration-skip-ink: none; text-underline-offset: -0.22lh; } mark { color: currentColor; background-color: color-mix(in srgb, currentColor, transparent 80%); } /* * lists * ----------------------------------------------------------- */ ul, ol { padding-inline-start: 2ch; margin: unset; margin-bottom: 1lh; max-width: 80ch; } ol { list-style-type: none; counter-reset: ordered-list; margin: unset; padding: unset; } ol li { padding-left: 3.6ch; position: relative; } ol li:before { counter-increment: ordered-list; content: counter(ordered-list) '.'; left: 0.2rem; position: absolute; } ol:not(:has(li:nth-child(10))) li { padding-left: 2.4ch; } ol:has(li:nth-child(10)) li:nth-child(-n + 9):before { left: 1.4ch; } li { padding: 0 0 0.3lh 0; } ul li:last-child { padding: 0; } ul li::marker { content: '– '; } /* * figure and image * ----------------------------------------------------------- */ img { display: block; border-radius: var(--gds-sys-radius-xs); } figure { margin: 0; padding: 0; margin-top: var(--gds-sys-space-xl); } figcaption { font-size: smaller; margin-block-start: var(--gds-sys-space-xs); } /* * table * ----------------------------------------------------------- */ table { border-collapse: separate; border-spacing: 0; width: 100%; border: var(--default-border); border-radius: var(--gds-sys-radius-s); margin-top: var(--gds-sys-space-xl); } th { font-weight: var(--gds-sys-text-weight-book); text-align: left; border-bottom: var(--default-border); border-left: transparent; border-right: transparent; color: currentColor; } th:not(:last-child) { border-right: var(--default-border); } th, td { padding: 0.3lh 2ch; } td:not(:last-child) { border-right: var(--default-border); } tr:nth-child(even) td { background: color-mix(in srgb, currentColor, transparent 95%); } /* * Details * ----------------------------------------------------------- */ details { border-top: solid var(--gds-sys-space-5xs) color-mix(in srgb, currentColor, transparent 90%); font: var(--gds-sys-text-body-m-regular); } summary { font-weight: var(--gds-sys-text-weight-regular); list-style: none; padding: 0.4lh 0.2ch; font: var(--gds-sys-text-body-l-regular); color: currentColor; display: flex; justify-content: space-between; align-items: center; cursor: pointer; user-select: none; outline-offset: var(--gds-sys-space-3xs); outline-color: currentColor; padding-inline: var(--gds-sys-space-m); } details summary::-webkit-details-marker { display: none; } summary:focus-visible { border-radius: var(--gds-sys-radius-2xs); } details:hover summary { background: color-mix(in srgb, currentColor, transparent 95%); } summary::after { content: '+'; display: flex; align-items: center; justify-content: center; width: 24px; height: 24px; font: var(--gds-sys-text-body-l-regular); } details[open] summary::after { content: '-'; } details[open] { border-bottom: var(--gds-sys-space-5xs) solid color-mix(in srgb, currentColor, transparent 95%); padding-bottom: 0.4lh; background: color-mix(in srgb, currentColor, transparent 95%); } details[open] > *:not(summary) { margin-left: var(--gds-sys-space-m); } details[open] summary { margin-bottom: 0.4lh; } details[open] + details { border: none; } details:last-of-type { border-bottom: var(--gds-sys-space-5xs) solid color-mix(in srgb, currentColor, transparent 90%); margin-bottom: var(--gds-sys-space-xl); } a, a:visited { color: currentColor; text-decoration-color: currentColor; } /* * Iframe */ iframe { border: var(--gds-sys-space-5xs) solid var(--gds-sys-color-border-neutral-02); border-radius: var(--gds-sys-radius-xs); min-width: 100%; margin-bottom: var(--gds-sys-space-l); } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/rich-text/rich-text.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/rich-text/rich-text.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsRichText", "declaration": { "name": "GdsRichText", "module": "src/components/rich-text/rich-text.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/segmented-control/segmented-control" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/segmented-control/segment/segment" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/segmented-control.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsSegmentedControl", "slots": [ { "description": "Segments to display in the control", "name": "" } ], "members": [ { "kind": "field", "name": "size", "type": { "text": "'small' | 'medium'" }, "default": "'medium'", "description": "Size of the segmented control", "attribute": "size", "reflects": true }, { "kind": "field", "name": "value", "description": "The value of the currently selected segment. Setting this property will\nselect the segment with the matching value.", "attribute": "value" }, { "kind": "field", "name": "segments", "description": "Returns the segments in the control", "readonly": true }, { "kind": "field", "name": "intersectionObserver", "type": { "text": "IntersectionObserver | null" }, "default": "null" }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fires when the selected segment is changed", "name": "change" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "'small' | 'medium'" }, "default": "'medium'", "description": "Size of the segmented control", "fieldName": "size", "attribute": "size" }, { "name": "value", "description": "The value of the currently selected segment. Setting this property will\nselect the segment with the matching value.", "fieldName": "value", "attribute": "value" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-segmented-control", "customElement": true, "subcomponents": [ { "tagName": "gds-segment", "description": "Defines a segment in the segmented control" } ] } ], "exports": [ { "kind": "js", "name": "GdsSegmentedControl", "declaration": { "name": "GdsSegmentedControl", "module": "src/components/segmented-control/segmented-control.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/segmented-control.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Segmented control', component: 'gds-segmented-control', subcomponents: { GdsSegment: 'gds-segment' }, parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-segmented-control'), }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/segmented-control)\n | \n[Usage guidelines](https://designlibrary.sebgroup.com/components/component-segmented-control)\n\nSegmentedControl allows users to select a single option, immediately changing the display to reflect their selection. It is used for switching views or view options, not for navigation." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" }, { "kind": "variable", "name": "Usage", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` First Second Third Fourth Fifth
    Selected: 2
    `, }", "description": "The `gds-segmented-control` element has a value-property that corresponds to the value of the selected segment.\nEach segment also needs to have a unique value-property set so thateach can be distinguished." }, { "kind": "variable", "name": "Small", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html` First Second Third `, }", "description": "There is a small and a medium version which can be configured using the `size` attribute." }, { "kind": "variable", "name": "SegmentSize", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html`
    Min-width Flaschenabfüllmaschine Long long label An even longer long label Pinetrees
    `, }", "description": "Segments can have different widths depending on the content, and if there are too many\nsegments to fit in the container, scroll buttons will appear to the left and/or right.\n\nSegment with can also be controlled individually on the segments using the `width`,\n`min-width` and `max-width` Style Expression properties." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/segmented-control/segmented-control.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/segmented-control/segmented-control.stories.ts" } }, { "kind": "js", "name": "Usage", "declaration": { "name": "Usage", "module": "src/components/segmented-control/segmented-control.stories.ts" } }, { "kind": "js", "name": "Small", "declaration": { "name": "Small", "module": "src/components/segmented-control/segmented-control.stories.ts" } }, { "kind": "js", "name": "SegmentSize", "declaration": { "name": "SegmentSize", "module": "src/components/segmented-control/segmented-control.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/segmented-control.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base { :host { background-color: var(--gds-sys-color-l3-neutral-02); border: 0.25rem solid transparent; border-radius: var(--gds-sys-radius-max); box-sizing: border-box; contain: layout; display: inline-flex; height: 3rem; width: 100%; position: relative; overflow: hidden; --_gds-segment-scroll-margin-inline: 2.75rem; } :host([size='small']) { height: 2.5rem; --_gds-segment-scroll-margin-inline: 2.25rem; } #track { box-sizing: border-box; display: flex; flex-grow: 1; scroll-snap-type: inline mandatory; scroll-padding-inline: var(--_gds-segment-scroll-margin-inline); overscroll-behavior-x: contain; scroll-behavior: smooth; overflow-x: scroll; gap: 0.25rem; position: relative; scrollbar-width: none; } #track::-webkit-scrollbar { display: none; } #btn-prev, #btn-next { box-sizing: border-box; align-items: center; appearance: none; aspect-ratio: 1; border-radius: var(--gds-sys-radius-max); border-width: 0; background-color: var(--gds-sys-color-l3-neutral-02); color: var(--gds-sys-color-content-neutral-01); cursor: pointer; box-shadow: 0 0 0 1px var(--gds-sys-color-l3-neutral-02); display: flex; font-size: 1rem; height: 100%; justify-content: center; width: 2.5rem; transition: 0.2s; z-index: 2; position: absolute; @media (pointer: fine) { &:hover { background-color: color-mix( in srgb, var(--gds-sys-color-l3-neutral-02), var(--gds-sys-color-state-neutral-03) ); } } } #btn-prev { margin: 0 0.25rem 0 0; } #btn-next { margin: 0 0 0 0.25rem; right: 0; } #btn-prev[aria-hidden='true'], #btn-next[aria-hidden='true'] { opacity: 0; width: 0; margin: 0; padding: 0; } :host([size='small']) #btn-prev, :host([size='small']) #btn-next { width: 2rem; } ::slotted(*) { flex-grow: 1; flex-shrink: 0; z-index: 1; scroll-margin-inline: var(--_gds-segment-scroll-margin-inline); scroll-snap-align: start; } #indicator { background-color: var(--gds-sys-color-l3-neutral-03); border-radius: var(--gds-sys-radius-max); height: 100%; left: 0; position: absolute; z-index: 0; transition: transform 0.2s, width 0.2s; z-index: 0; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/segmented-control/segmented-control.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/segmented-control.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/segmented-control/segmented-control.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/segmented-control/segmented-control.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/segmented-control.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsSegmentedControl", "declaration": { "name": "GdsSegmentedControl", "module": "src/components/segmented-control/segmented-control.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/select/select" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsSelect", "slots": [ { "description": "Default slot for the native select element", "name": "" }, { "description": "Slot for leading content (e.g., icons)", "name": "lead" } ], "events": [ { "type": { "text": "CustomEvent" }, "description": "Fired when the selection changes with detail: { value: string }", "name": "change" }, { "type": { "text": "CustomEvent" }, "description": "Fired on input with detail: { value: string }", "name": "input" }, { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "Select", "module": "src/components/select/select.component.ts" }, "tagName": "gds-select", "customElement": true, "members": [ { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "supportingText", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field.\nThis text provides additional context or information to the user.", "attribute": "supporting-text", "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "kind": "field", "name": "showExtendedSupportingText", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "attribute": "show-extended-supporting-text", "reflects": true, "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "kind": "field", "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size of texts and height of the field.", "attribute": "size", "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "kind": "field", "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Hides the header and the footer, while still keeping the accessible label\n\nAlways set the `label` attribute, and if you need to hide it, add this attribute and keep `label` set.", "attribute": "plain", "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "kind": "field", "name": "selectElement", "type": { "text": "HTMLSelectElement | undefined" }, "description": "Reference to the native select element.", "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "kind": "field", "name": "value", "description": "The value of the select element.\nThis property can be either a single value or an array of values, depending on the multiple attribute of the select element.\n\nOnly use this property, and not the value property of the wrapped select element.", "attribute": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "displayValue", "description": "Returns the display value for the select component.\nFor single-select mode, this is the selected option text.\nFor multi-select mode, this is a comma-separated list of selected option texts.", "readonly": true, "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "kind": "field", "name": "multiple", "description": "Wheter the select element is in multiple selection mode.", "readonly": true, "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "kind": "method", "name": "formResetCallback", "return": { "type": { "text": "void" } }, "description": "Handles form reset events by selecting the first option.", "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "kind": "method", "name": "_getValidityAnchor", "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "supporting-text", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field.\nThis text provides additional context or information to the user.", "fieldName": "supportingText", "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "name": "show-extended-supporting-text", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "fieldName": "showExtendedSupportingText", "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size of texts and height of the field.", "fieldName": "size", "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Hides the header and the footer, while still keeping the accessible label\n\nAlways set the `label` attribute, and if you need to hide it, add this attribute and keep `label` set.", "fieldName": "plain", "inheritedFrom": { "name": "Select", "module": "src/components/select/select.component.ts" } }, { "name": "value", "description": "The value of the select element.\nThis property can be either a single value or an array of values, depending on the multiple attribute of the select element.\n\nOnly use this property, and not the value property of the wrapped select element.", "fieldName": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "fieldName": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSelect", "declaration": { "name": "GdsSelect", "module": "src/components/select/select.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Select', component: 'gds-select', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-select'), }, }", "description": "A select enables the user to choose a single option from a list.\n\n`gds-select` is a wrapper component for the native select element.\n\nUse this component instead of `` when you need to leverage the inherent behavior of the native select element, for example when native accessibility features, some of which are not currently replicable in custom dropdowns, are required. Usability on mobile devices is also sometimes better with native select elements.\n\nDon't use this component when you need to customize the dropdown behavior or appearance, or when you need to display complex content in the dropdown, or require multi-select functionality. While the native select element does support multi-select, it is not recommended for use in most cases.\n\nThe wrapped select element will be cloned into the component's shadow DOM. Therefore, event listeners should only be added on the host\nelement, and not on the enclosed select element. Also, state should also be handled only through the host.\nSetting value or selected props on the select element will not work as expected." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Select', args: { label: 'Label text', supportingText: 'Supporting text', value: '', innerHTML: ` `, }, }", "description": "Basic example showing the select component with a label, supporting text and a lead icon.\nThe wrapped ` `, }", "description": "> In web components using Shadow DOM, elements cannot be associated with each other across Shadow DOM boundaries. This is why you need to wrap a full native `select` element and it's options, rather than just putting options directly under ``. If placed in a slot, options would not be picked up due to the Shadow DOM encapsulation." }, { "kind": "variable", "name": "Lead", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Lead Icon', render: () => html` Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "The lead icon is displayed to the left of the select field.\n
    It can be used to provide additional context or to visually represent the select field's purpose.\n
    It is set by adding an icon component to the 'lead' slot." }, { "kind": "variable", "name": "Disabled", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Disabled', render: () => html` Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "The `disabled` property can be set to disable the `gds-select` field.\n
    e.g\n\n```html\n ... \n```" }, { "kind": "variable", "name": "Invalid", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Invalid', render: () => html` Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "The invalid state can be set either directly using the `invalid` boolean property together with the `error-message` property, or by using a [validator](/docs/components-form-validation--docs)." }, { "kind": "variable", "name": "ExtendedSupportingText", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Extended Supporting Text', render: () => html` Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "The `extended-supporting-text` slot can be used to provide extended information about the select field.
    \nThe slot will show by default when the `show-extended-supporting-text` property is set.
    \nIf not specified, the slot will be hidden and a companion icon will be displayed to indicate that more information is available.\n\n```html\n\n ...\n \n\n```" }, { "kind": "variable", "name": "Size", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Size', render: () => html` Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "The `size` property can be set to 'small' to reduce the size of the select field.
    \n**@property size** - The size of the select field.\n\n```html\n \n```" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/select/select.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/select/select.stories.ts" } }, { "kind": "js", "name": "Option", "declaration": { "name": "Option", "module": "src/components/select/select.stories.ts" } }, { "kind": "js", "name": "Lead", "declaration": { "name": "Lead", "module": "src/components/select/select.stories.ts" } }, { "kind": "js", "name": "Disabled", "declaration": { "name": "Disabled", "module": "src/components/select/select.stories.ts" } }, { "kind": "js", "name": "Invalid", "declaration": { "name": "Invalid", "module": "src/components/select/select.stories.ts" } }, { "kind": "js", "name": "ExtendedSupportingText", "declaration": { "name": "ExtendedSupportingText", "module": "src/components/select/select.stories.ts" } }, { "kind": "js", "name": "Size", "declaration": { "name": "Size", "module": "src/components/select/select.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base, reset, transitional-styles; @layer base { .select-container { display: contents; } select { flex: 1; height: 100%; opacity: 0; position: absolute; z-index: 1; inset: 0; &::-ms-expand { display: none; } } select[multiple] { opacity: 1; position: relative; width: 100%; } label { flex: 1; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/select/select.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/select/select.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/select/select.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsSelect", "declaration": { "name": "GdsSelect", "module": "src/components/select/select.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/sensitive/number" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/sensitive/date" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/sensitive/account" } } ] }, { "kind": "javascript-module", "path": "src/components/signal/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/signal/signal" } } ] }, { "kind": "javascript-module", "path": "src/components/signal/signal.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsSignal", "members": [ { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Change signal color based on variant.\nThe color can be customized using the `color` property.", "category": "Declarative layout / Style expression properties" }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-signal", "customElement": true, "attributes": [ { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSignal", "declaration": { "name": "GdsSignal", "module": "src/components/signal/signal.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/signal/signal.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Signal', component: 'gds-signal', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-signal'), }, }" }, { "kind": "variable", "name": "Signal", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Signal', }", "description": "A signal is used to draw attention to notifications and new content.
    " }, { "kind": "variable", "name": "Color", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Color', render: (args) => html` `, }", "description": "The signal's style matches the button's rank and variant by default.
    \nThe color can be customized using the `color` property. It accepts as value all the content color tokens.\n\nColor tokens: seb.io/studio/colors" }, { "kind": "variable", "name": "Usage", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Usage', render: (args) => html` Primary `, }", "description": "Signal can be used on the FAB by setting it as trail slot element." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/signal/signal.stories.ts" } }, { "kind": "js", "name": "Signal", "declaration": { "name": "Signal", "module": "src/components/signal/signal.stories.ts" } }, { "kind": "js", "name": "Color", "declaration": { "name": "Color", "module": "src/components/signal/signal.stories.ts" } }, { "kind": "js", "name": "Usage", "declaration": { "name": "Usage", "module": "src/components/signal/signal.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/signal/signal.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { display: inline-block; } [part='signal'] { display: flex; align-items: center; justify-content: center; position: relative; width: 6px; height: 6px; border-radius: var(--gds-sys-radius-max); background-color: currentColor; transition: all 0.4s; &::before { display: flex; position: absolute; content: ''; inset: -4px; border-radius: inherit; background-color: color-mix(in srgb, currentColor, transparent 80%); animation: signal 3s ease-in-out infinite; } } @keyframes signal { 0% { transform: scale(2); opacity: 0; } 60% { transform: scale(1); opacity: 1; } 100% { transform: scale(3); opacity: 0; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/signal/signal.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/signal/signal.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsSignal", "declaration": { "name": "GdsSignal", "module": "src/components/signal/signal.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/spinner/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/spinner/spinner" } } ] }, { "kind": "javascript-module", "path": "src/components/spinner/spinner.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsSpinner", "members": [ { "kind": "field", "name": "label", "type": { "text": "string" }, "description": "The text to display as a label for the spinner", "attribute": "label" }, { "kind": "field", "name": "labelPosition", "type": { "text": "'top' | 'bottom' | 'left' | 'right'" }, "default": "'bottom'", "attribute": "label-position", "reflects": true }, { "kind": "field", "name": "showLabel", "type": { "text": "boolean" }, "default": "false", "description": "Whether to display the label text visually\nIf false, the label is still available for screen readers", "attribute": "showLabel", "reflects": true }, { "kind": "field", "name": "cover", "type": { "text": "boolean" }, "default": "false", "description": "When true, covers the parent container with a semi-transparent backdrop\nParent must have position: relative", "attribute": "cover", "reflects": true }, { "kind": "field", "name": "fullscreen", "type": { "text": "boolean" }, "default": "false", "description": "When true, covers the entire viewport with a fixed position backdrop", "attribute": "fullscreen", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "'sm' | 'md' | 'lg'" }, "default": "'md'", "description": "Size variant of the spinner", "attribute": "size", "reflects": true }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "When the spinner is connected and visible", "name": "gds-spinner-connected" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "description": "The text to display as a label for the spinner", "fieldName": "label" }, { "name": "label-position", "type": { "text": "'top' | 'bottom' | 'left' | 'right'" }, "default": "'bottom'", "fieldName": "labelPosition" }, { "name": "showLabel", "type": { "text": "boolean" }, "default": "false", "description": "Whether to display the label text visually\nIf false, the label is still available for screen readers", "fieldName": "showLabel" }, { "name": "cover", "type": { "text": "boolean" }, "default": "false", "description": "When true, covers the parent container with a semi-transparent backdrop\nParent must have position: relative", "fieldName": "cover" }, { "name": "fullscreen", "type": { "text": "boolean" }, "default": "false", "description": "When true, covers the entire viewport with a fixed position backdrop", "fieldName": "fullscreen" }, { "name": "size", "type": { "text": "'sm' | 'md' | 'lg'" }, "default": "'md'", "description": "Size variant of the spinner", "fieldName": "size" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withPositioningProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-spinner", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsSpinner", "declaration": { "name": "GdsSpinner", "module": "src/components/spinner/spinner.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/spinner/spinner.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Spinner', component: 'gds-spinner', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-textarea'), }, }", "description": "A spinner is an indeterminate progress indicator." }, { "kind": "variable", "name": "Playground", "type": { "text": "Story" }, "default": "{ args: { size: 'md', showLabel: true, cover: false, fullscreen: false, }, render: (args) => html` Container Content This is some sample content in the container. More content here... `, }" }, { "kind": "variable", "name": "Sizes", "type": { "text": "Story" }, "default": "{ name: 'Size Variants', render: () => html` `, }" }, { "kind": "variable", "name": "LabelOptions", "type": { "text": "Story" }, "default": "{ name: 'Label Options', render: () => html` 0{2}\"> Hidden Label Visible Label Label top Label left Label right `, }", "description": "The label is hidden by default, but can also be shown visually. A label should always be provided for accessibility reasons.\nThe position of the label can also be customized to appear on top, left, or right of the spinner. this is done with the `label-position` attribute." }, { "kind": "variable", "name": "Cover", "type": { "text": "Story" }, "default": "{ name: 'Container Cover', render: () => html` Container Content This is some sample content in the container. More content here... `, }", "description": "By setting the container position to relative, the spinner can cover the entire container by using the `cover` attribute." }, { "kind": "variable", "name": "Fullscreen", "type": { "text": "Story" }, "default": "{ name: 'Fullscreen Mode', render: () => { return html` { const spinner = e.target as any spinner.fullscreen = !spinner.fullscreen }} > ` }, }", "description": "The fullscreen spinner covers the entire viewport and prevents scrolling.\n\nCheck this example in story view by clicking on it in the menu on the left." }, { "kind": "variable", "name": "ThemeModes", "type": { "text": "Story" }, "default": "{ name: 'Light & Dark Theme', render: (args, { context }) => { // Function to handle the theme toggle const handleThemeToggle = (e: Event) => { const demo = document.getElementById('theme-demo-container') if (demo) { const isDark = demo.getAttribute('color-scheme') === 'dark' if (isDark) { demo.setAttribute('color-scheme', 'light') ;(e.target as HTMLButtonElement).textContent = 'Switch to Dark Theme' } else { demo.setAttribute('color-scheme', 'dark') ;(e.target as HTMLButtonElement).textContent = 'Switch to Light Theme' } } } return html` Theme Mode Demonstration The spinner automatically adapts to light and dark themes:
    Switch to Dark Theme
    Standard Spinner With Label With Cover Content     ` }, }", "description": "The spinner colors adaps to the current user settings, and the label uses currentColor\nto inherit the text color." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/spinner/spinner.stories.ts" } }, { "kind": "js", "name": "Playground", "declaration": { "name": "Playground", "module": "src/components/spinner/spinner.stories.ts" } }, { "kind": "js", "name": "Sizes", "declaration": { "name": "Sizes", "module": "src/components/spinner/spinner.stories.ts" } }, { "kind": "js", "name": "LabelOptions", "declaration": { "name": "LabelOptions", "module": "src/components/spinner/spinner.stories.ts" } }, { "kind": "js", "name": "Cover", "declaration": { "name": "Cover", "module": "src/components/spinner/spinner.stories.ts" } }, { "kind": "js", "name": "Fullscreen", "declaration": { "name": "Fullscreen", "module": "src/components/spinner/spinner.stories.ts" } }, { "kind": "js", "name": "ThemeModes", "declaration": { "name": "ThemeModes", "module": "src/components/spinner/spinner.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/spinner/spinner.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` /* Host configuration with core variables */ :host { /* Size variables with indexed access using CSS custom properties */ --spinner-sizes: 2rem 3.75rem 6rem; --spinner-size-sm: 2rem; --spinner-size-md: 3.75rem; --spinner-size-lg: 6rem; --track-widths: 0.1rem 0.2rem 0.3rem; --track-width-sm: 0.275rem; --track-width-md: 0.375rem; --track-width-lg: 0.375rem; /* Default to light mode as fallback */ --spinner-track-color: var(--gds-sys-color-l3-neutral-02); --spinner-active-color: var(--gds-sys-color-content-neutral-02); --spinner-label-color: currentColor; --spinner-backdrop-color: rgba(100, 100, 100, 0.4); --spinner-backdrop-blur: 2px; /* Base sizing, will be overridden by size-specific variables */ --size: var(--spinner-size-md); --track-width: var(--track-width-md); /* Use CSS variable for color-scheme to avoid minification issues */ --spinner-color-scheme: light dark; color-scheme: var(--spinner-color-scheme); display: block; } /* Size-specific host settings */ :host([size='sm']) { --size: var(--spinner-size-sm); --track-width: var(--track-width-sm); } :host([size='md']), :host([size='default']) { --size: var(--spinner-size-md); --track-width: var(--track-width-md); } :host([size='lg']) { --size: var(--spinner-size-lg); --track-width: var(--track-width-lg); } /* Fullscreen positioning */ :host([fullscreen]) { position: fixed; inset: 0; width: 100vw; height: 100vh; z-index: 9999; } /* Focus styles */ :host(:focus-visible) { outline: 2px solid var(--spinner-active-color); outline-offset: 2px; } /* Spinner component */ .spinner { border-radius: 50%; border: var(--track-width, 0.375rem) solid var(--spinner-track-color); border-top-color: var(--spinner-active-color); height: var(--size, 3.75rem); width: var(--size, 3.75rem); animation: gdsSpinnerRotation 1s linear infinite; aspect-ratio: 1 / 1; } /* Motion preference adjustments */ @media (prefers-reduced-motion: reduce) { .spinner { /* Slower rotation for reduced motion preference */ animation-duration: 2s; /* Smaller rotation to reduce visual intensity */ animation-name: gdsSpinnerReducedRotation; } @keyframes gdsSpinnerReducedRotation { to { transform: rotate(180deg); } } } /* Layout components */ .spinner-wrapper { display: flex; justify-content: center; align-items: center; flex-direction: column; } .spinner-wrapper.spinner-cover { position: absolute; inset: 0; z-index: 999; } .spinner-wrapper.spinner-fullscreen { position: fixed; inset: 0; z-index: 9999; } .spinner-wrapper.spinner-backdrop { background-color: var(--spinner-backdrop-color); backdrop-filter: blur(var(--spinner-backdrop-blur)); } .spinner-wrapper.spinner-label-top { flex-direction: column-reverse; & .spinner-label { margin: 0 0 1rem; } } .spinner-wrapper.spinner-label-left { flex-direction: row-reverse; & .spinner-label { margin: 0 1rem 0 0; } } .spinner-wrapper.spinner-label-right { flex-direction: row; & .spinner-label { margin: 0 0 0 1rem; } } /* Label styling */ .spinner-label { margin-top: 1rem; color: var(--spinner-label-color); text-align: center; } /* Animation keyframes */ @keyframes gdsSpinnerRotation { to { transform: rotate(360deg); } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/spinner/spinner.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/spinner/spinner.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsSpinner", "declaration": { "name": "GdsSpinner", "module": "src/components/spinner/spinner.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/table/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/table/table" } }, { "kind": "js", "name": "*", "declaration": { "name": "Types", "module": "src/components/table/table.types" } } ] }, { "kind": "javascript-module", "path": "src/components/table/table.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsTable", "slots": [ { "description": "Content displayed at the start of the table header (after search).", "name": "`header-lead`" }, { "description": "Content displayed at the end of the table header (before settings).", "name": "`header-trail`" }, { "description": "Content displayed in the table footer area (before pagination).", "name": "`footer`" }, { "description": "Custom error state content when data loading fails.", "name": "`error`" }, { "description": "Custom empty state content when no data is available.", "name": "`empty`" }, { "description": "Custom no results content when search returns empty.", "name": "`no-results`" } ], "members": [ { "kind": "field", "name": "headline", "type": { "text": "string | undefined" }, "description": "The main headline text displayed at the top of the table.", "attribute": "headline" }, { "kind": "field", "name": "headlineTag", "type": { "text": "string" }, "default": "'h2'", "description": "The HTML tag to use for the headline (e.g., 'h1', 'h2', etc.).", "attribute": "headline-tag", "reflects": true }, { "kind": "field", "name": "summary", "type": { "text": "string | undefined" }, "description": "A brief description or summary displayed below the headline.", "attribute": "summary" }, { "kind": "field", "name": "searchLabel", "type": { "text": "string | undefined" }, "description": "The accessible label for the search input field.", "attribute": "search-label" }, { "kind": "field", "name": "options", "type": { "text": "array" }, "default": "[5, 10, 20, 50, 100]", "description": "Configurable options for rows per page.\nAccepts: number array (e.g., `[5, 10, 20, 50, 100]`)", "attribute": "options" }, { "kind": "field", "name": "page", "type": { "text": "number" }, "default": "1", "description": "Current page number in pagination.", "attribute": "page" }, { "kind": "field", "name": "rows", "type": { "text": "number" }, "default": "10", "description": "Number of rows displayed per page.", "attribute": "rows" }, { "kind": "field", "name": "columns", "type": { "text": "Types.Column[]" }, "default": "[]", "description": "Defines table column structure.\nAccepts: array of column configurations with keys, labels, etc.", "attribute": "columns" }, { "kind": "field", "name": "data", "type": { "text": "(request: Types.Request) => Promise>" }, "description": "Asynchronous data provider function.\nAccepts: function that returns Promise with rows and total count", "attribute": "data" }, { "kind": "field", "name": "density", "type": { "text": "Types.Density" }, "default": "'comfortable'", "description": "Controls row density.\nAccepts: `comfortable`, `compact`, `spacious`", "attribute": "density" }, { "kind": "field", "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Enables row selection functionality.", "attribute": "selectable" }, { "kind": "field", "name": "disableSelectAll", "type": { "text": "boolean" }, "default": "false", "description": "Disables select all checkbox in header.", "attribute": "disable-select-all" }, { "kind": "field", "name": "responsive", "type": { "text": "boolean" }, "default": "false", "description": "Transforms table layout for mobile screens.", "attribute": "responsive" }, { "kind": "field", "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Removes table header and footer.", "attribute": "plain" }, { "kind": "field", "name": "searchable", "type": { "text": "boolean" }, "default": "false", "description": "Adds search input for data filtering.", "attribute": "searchable" }, { "kind": "field", "name": "settings", "type": { "text": "boolean" }, "default": "false", "description": "Enables column visibility settings.", "attribute": "settings" }, { "kind": "field", "name": "striped", "type": { "text": "boolean" }, "default": "false", "description": "Applies alternating row background colors.", "attribute": "striped" }, { "kind": "field", "name": "actions", "type": { "text": "Types.Actions | ((row: T, index: number) => any) | undefined" }, "description": "Defines row-level actions.\nAccepts: action configuration or custom rendering function", "attribute": "actions" }, { "kind": "field", "name": "nocache", "type": { "text": "boolean" }, "default": "false", "description": "Disables data caching mechanism.", "attribute": "nocache" }, { "kind": "field", "name": "tfoot", "type": { "text": "Types.Tfoot | undefined" }, "description": "Configures a table footer row (``) at the bottom of the table.\nThe footer row provides slot insertion points for each visible column,\nletting consumers render any aggregation (sum, average, count, etc.).\n\nUse `tfoot.label` to optionally show a label in the first cell (omitted by default).\nUse `tfoot.sticky` to pin the footer to the bottom of the scroll area.\n\nSlot naming convention: `tfoot:{columnKey}`\n\nAccepts: `{ label?: string, sticky?: boolean }` or omit to disable.", "attribute": "tfoot" }, { "kind": "field", "name": "dataLoadKey", "type": { "text": "string | undefined" }, "description": "Key to trigger data reloading when changed. Setting this to a new value\nforces the table to clear the cache and request new data from the data provider.\n\nThe value can be any string that is not equal to the previous value.", "attribute": "dataLoadKey" }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the height property.\nSupports space tokens and all valid CSS width values.\n\nSets the height of the table content area and enables vertical scrolling\nwith a sticky header that remains visible.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "variant", "type": { "text": "Omit" }, "default": "'neutral-02-outlined'", "description": "Sets the visual variant of the table container card.\nForwards to the underlying `gds-card` component.", "attribute": "variant" }, { "kind": "method", "name": "clearSelection", "return": { "type": { "text": "void" } }, "description": "Public API\nClear all selections" }, { "kind": "method", "name": "selectAll", "return": { "type": { "text": "void" } }, "description": "Select all rows" }, { "kind": "method", "name": "setSelection", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "indices", "type": { "text": "number[]" } } ], "description": "Select specific rows by indices" }, { "kind": "method", "name": "getSelection", "return": { "type": { "text": "{ indices: number[]; data: T[] }" } }, "description": "Get selected row data" }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when the active page changes. Detail: `{ page: number }`", "name": "gds-page-change" }, { "description": "Fired when the rows per page value changes. Detail: `{ rows: number }`", "name": "gds-rows-change" }, { "description": "Fired when sorting changes. Detail: `{ sortColumn: string, sortDirection: 'asc' | 'desc' }`", "name": "gds-sort-change" }, { "description": "Fired when data is successfully loaded. Detail: `{ rows: T[], total: number, page: number, rowsPerPage: number, searchQuery: string, sortColumn?: string, sortDirection?: 'asc' | 'desc' }`", "name": "gds-table-data-loaded" }, { "description": "Fired when data loading fails.", "name": "gds-table-data-error" }, { "description": "Fired when row selection changes.", "name": "gds-table-selection" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "headline", "type": { "text": "string | undefined" }, "description": "The main headline text displayed at the top of the table.", "fieldName": "headline" }, { "name": "headline-tag", "type": { "text": "string" }, "default": "'h2'", "description": "The HTML tag to use for the headline (e.g., 'h1', 'h2', etc.).", "fieldName": "headlineTag" }, { "name": "summary", "type": { "text": "string | undefined" }, "description": "A brief description or summary displayed below the headline.", "fieldName": "summary" }, { "name": "search-label", "type": { "text": "string | undefined" }, "description": "The accessible label for the search input field.", "fieldName": "searchLabel" }, { "name": "options", "type": { "text": "array" }, "default": "[5, 10, 20, 50, 100]", "description": "Configurable options for rows per page.\nAccepts: number array (e.g., `[5, 10, 20, 50, 100]`)", "fieldName": "options" }, { "name": "page", "type": { "text": "number" }, "default": "1", "description": "Current page number in pagination.", "fieldName": "page" }, { "name": "rows", "type": { "text": "number" }, "default": "10", "description": "Number of rows displayed per page.", "fieldName": "rows" }, { "name": "columns", "type": { "text": "Types.Column[]" }, "default": "[]", "description": "Defines table column structure.\nAccepts: array of column configurations with keys, labels, etc.", "fieldName": "columns" }, { "name": "data", "type": { "text": "(request: Types.Request) => Promise>" }, "description": "Asynchronous data provider function.\nAccepts: function that returns Promise with rows and total count", "fieldName": "data" }, { "name": "density", "type": { "text": "Types.Density" }, "default": "'comfortable'", "description": "Controls row density.\nAccepts: `comfortable`, `compact`, `spacious`", "fieldName": "density" }, { "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Enables row selection functionality.", "fieldName": "selectable" }, { "name": "disable-select-all", "type": { "text": "boolean" }, "default": "false", "description": "Disables select all checkbox in header.", "fieldName": "disableSelectAll" }, { "name": "responsive", "type": { "text": "boolean" }, "default": "false", "description": "Transforms table layout for mobile screens.", "fieldName": "responsive" }, { "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Removes table header and footer.", "fieldName": "plain" }, { "name": "searchable", "type": { "text": "boolean" }, "default": "false", "description": "Adds search input for data filtering.", "fieldName": "searchable" }, { "name": "settings", "type": { "text": "boolean" }, "default": "false", "description": "Enables column visibility settings.", "fieldName": "settings" }, { "name": "striped", "type": { "text": "boolean" }, "default": "false", "description": "Applies alternating row background colors.", "fieldName": "striped" }, { "name": "actions", "type": { "text": "Types.Actions | ((row: T, index: number) => any) | undefined" }, "description": "Defines row-level actions.\nAccepts: action configuration or custom rendering function", "fieldName": "actions" }, { "name": "nocache", "type": { "text": "boolean" }, "default": "false", "description": "Disables data caching mechanism.", "fieldName": "nocache" }, { "name": "tfoot", "type": { "text": "Types.Tfoot | undefined" }, "description": "Configures a table footer row (``) at the bottom of the table.\nThe footer row provides slot insertion points for each visible column,\nletting consumers render any aggregation (sum, average, count, etc.).\n\nUse `tfoot.label` to optionally show a label in the first cell (omitted by default).\nUse `tfoot.sticky` to pin the footer to the bottom of the scroll area.\n\nSlot naming convention: `tfoot:{columnKey}`\n\nAccepts: `{ label?: string, sticky?: boolean }` or omit to disable.", "fieldName": "tfoot" }, { "name": "dataLoadKey", "type": { "text": "string | undefined" }, "description": "Key to trigger data reloading when changed. Setting this to a new value\nforces the table to clear the cache and request new data from the data provider.\n\nThe value can be any string that is not equal to the previous value.", "fieldName": "dataLoadKey" }, { "name": "variant", "type": { "text": "Omit" }, "default": "'neutral-02-outlined'", "description": "Sets the visual variant of the table container card.\nForwards to the underlying `gds-card` component.", "fieldName": "variant" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-table", "customElement": true, "summary": "A data table component with async data loading, pagination, sorting, filtering, and customizable cell rendering." } ], "exports": [ { "kind": "js", "name": "GdsTable", "declaration": { "name": "GdsTable", "module": "src/components/table/table.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/table/table.imports.ts", "declarations": [ { "kind": "variable", "name": "Styles", "type": { "text": "array" }, "default": "[tokens, checkboxStyles, TableStyles]" }, { "kind": "variable", "name": "Dependencies", "type": { "text": "array" }, "default": "[ GdsButton, GdsCard, GdsDivider, GdsImg, GdsContextMenu, GdsMenuItem, GdsDropdown, GdsInput, GdsPagination, GdsText, GdsBadge, GdsLink, GdsFlex, IconCopy, IconCrossSmall, IconMinusSmall, IconMagnifyingGlass, IconSort, IconSortDown, IconSortUp, IconDotGridOneHorizontal, ]" } ], "exports": [ { "kind": "js", "name": "Checkbox", "declaration": { "name": "checkboxToggle", "module": "../../shared-styles/rbcb-toggle.template" } }, { "kind": "js", "name": "FormatAccount", "declaration": { "name": "accountsFormats", "module": "../formatted-text/formatters" } }, { "kind": "js", "name": "FormatDate", "declaration": { "name": "dateTimeFormats", "module": "../formatted-text/formatters" } }, { "kind": "js", "name": "FormatNumber", "declaration": { "name": "numberFormats", "module": "../formatted-text/formatters" } }, { "kind": "js", "name": "Styles", "declaration": { "name": "Styles", "module": "src/components/table/table.imports.ts" } }, { "kind": "js", "name": "Dependencies", "declaration": { "name": "Dependencies", "module": "src/components/table/table.imports.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/table/table.stories.data.ts", "declarations": [ { "kind": "variable", "name": "Users", "type": { "text": "object" }, "default": "{ Columns: [ { key: 'id', label: 'ID', sortable: false, }, { key: 'name', label: 'Name', sortable: true, }, { key: 'email', label: 'Email', sortable: true, justify: 'space-between', }, { key: 'role', label: 'Role', sortable: true, visible: false, }, { key: 'status', label: 'Status', sortable: true, }, { key: 'department', label: 'Department', sortable: true, }, { key: 'amount', label: 'Amount', sortable: true, justify: 'end', }, { key: 'account', label: 'Account', sortable: true, }, { key: 'login', label: 'Last Login', sortable: true, }, { key: 'download', label: 'Download', }, ] as TableColumn[], Actions: { label: 'Actions', justify: 'end', } as TableActions, Tfoot: { label: 'Totals', sticky: true, } as TableTfoot, Data: userDataProvider, /** * Generates slot content for the given rows (current page). * Creates per-row slot elements using `columnKey:rowKey:slotId` convention. * * Used with Lit's `render()` to update table light DOM on each data load: * ```ts * @gds-table-data-loaded=${(e) => render(Users.SlotContent(e.detail.rows), table)} * ``` */ SlotContent: (rows: any[]): TemplateResult => { return html` ${rows.map( (row: any) => html` ${String(row.status)} SEK Download file Edit ${String(row.name)} Delete `, )} ` }, /** * Generates tfoot slot content for the footer row. * Receives all rows on the page and computes aggregations. * * Slot naming: `tfoot:{columnKey}` */ TfootSlotContent: (rows: any[]): TemplateResult => { const totalAmount = rows.reduce( (sum, row) => sum + (Number(row.amount) || 0), 0, ) const activeCount = rows.filter( (row) => String(row.status) === 'Active', ).length const activeRate = Math.round((activeCount / rows.length) * 100) const departments = new Set(rows.map((row) => row.department)).size return html` ${rows.length} Users = 70 ? 'positive' : activeRate >= 40 ? 'warning' : 'negative'}\" size=\"small\" > ${activeRate}% active ${departments} depts SEK ` }, }" }, { "kind": "variable", "name": "Feedback", "type": { "text": "object" }, "default": "{ Columns: [ { key: 'name', label: 'Name', sortable: true, align: 'start', }, { key: 'feedback', label: 'Feedback', align: 'start', width: '350px', }, { key: 'notes', label: 'Notes', align: 'start', width: '460px', }, { key: 'department', label: 'Department', align: 'start', width: '120px', }, { key: 'status', label: 'Status', sortable: true, align: 'start', justify: 'end', width: '100px', }, ] as TableColumn[], Data: feedbackDataProvider, }" }, { "kind": "variable", "name": "Actions", "type": { "text": "object" }, "default": "{ Columns: [ { key: 'task', label: 'Task', align: 'center' }, { key: 'assignee', label: 'Assignee', align: 'center' }, { key: 'priority', label: 'Priority', align: 'center', width: '100px' }, ] as TableColumn[], MultipleActions: { label: 'Actions', align: 'center', justify: 'start', // width: '150px', sticky: true, } as TableActions, MultipleActionsSlotContent: (rows: any[]): TemplateResult => { return html` ${rows.map( (row: any, i: number) => html` `, )} ` }, ActionLink: { label: 'Actions', align: 'center', justify: 'end', // width: '150px', sticky: true, } as TableActions, ActionLinkSlotContent: (rows: any[]): TemplateResult => { return html` ${rows.map( (row: any, i: number) => html` View details `, )} ` }, ActionContextMenu: { label: 'Actions', align: 'center', justify: 'end', // width: '150px', sticky: true, } as TableActions, ActionContextMenuSlotContent: (rows: any[]): TemplateResult => { return html` ${rows.map( (row: any, i: number) => html` Edit Archive Delete `, )} ` }, Data: actionsDataProvider, }" } ], "exports": [ { "kind": "js", "name": "Users", "declaration": { "name": "Users", "module": "src/components/table/table.stories.data.ts" } }, { "kind": "js", "name": "Feedback", "declaration": { "name": "Feedback", "module": "src/components/table/table.stories.data.ts" } }, { "kind": "js", "name": "Actions", "declaration": { "name": "Actions", "module": "src/components/table/table.stories.data.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/table/table.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Table', component: 'gds-table', argTypes: { ...argTablePropsFor('gds-table'), density: { control: { type: 'select' }, options: ['comfortable', 'compact', 'spacious'], defaultValue: 'comfortable', }, variant: { control: { type: 'select' }, options: [ 'neutral-01', 'neutral-01-2', 'neutral-02', 'neutral-02-2', 'neutral-02-outlined', ] as Variant[], defaultValue: 'neutral-02-outlined', }, selectable: { control: { type: 'boolean' }, defaultValue: true, }, searchLabel: { control: { type: 'text' }, }, height: { control: { type: 'string' }, defaultValue: false, }, }, tags: ['autodocs'], decorators: [ (storyFn: any, context: any) => context.viewMode === 'docs' ? lazyStory(() => storyFn()) : storyFn(), ], parameters: { docs: { description: { component: ` A data table component that handles asynchronous data loading, pagination, sorting, and filtering through a provider function. Supports row selection, searchable columns, responsive layouts, and customizable cell rendering including badges, buttons, links, and formatted values. `, }, }, }, }" }, { "kind": "variable", "name": "Overview", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, actions: Users.Actions, density: 'comfortable', variant: 'neutral-02-outlined' as Variant, data: Users.Data, selectable: true, searchable: true, searchLabel: 'Search users', settings: true, plain: false, height: '80vh', responsive: false, nocache: false, striped: false, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Selection", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, selectable: true, density: 'comfortable', }, parameters: { docs: { description: { story: ` The \\`selectable\\` boolean enables row selection with checkboxes. Supports individual row selection, select all via header checkbox, and partial selection indication. Emits \\`gds-table-selection\\` event with selected row data and indices. Provides methods for programmatic selection control. See Developer Guide for complete selection API documentation. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Filtering", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, searchable: true, settings: true, }, parameters: { docs: { description: { story: ` #### Search Functionality The \\`searchable\\` property adds a search input to the table, enabling real-time filtering across all columns. #### Column Settings The \\`settings\\` property adds a column visibility dropdown, allowing users to show/hide specific columns. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Caching", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, searchable: true, settings: true, nocache: true, }, parameters: { docs: { description: { story: ` The \\`nocache\\` property provides direct control over data retrieval. When set to \\`true\\`, the table bypasses its internal caching mechanism, fetching fresh data on each request. By default, the table caches sorted and filtered results for 5 minutes to improve performance. > Note: The example is simulated with a mock data provider introducing a 1000ms delay to demonstrate real-world data fetching scenarios. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Sorting", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, }, parameters: { docs: { description: { story: ` Sorting is enabled by setting \\`sortable: true\\` on column configuration.
    Clicking a sortable column header toggles between ascending and descending order, resetting the table to the first page.
    The sorting mechanism generates a unique cache key, caching sorted results for 5 minutes, and emits a \\`gds-table-data-loaded\\` event with the sorted data. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Cell", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, }, parameters: { docs: { description: { story: ` The table supports multiple cell types: badge, image, button, link, context menu, and formatted text (number, account, date). Cell types correspond to their respective Green Design System components and accept their available properties for customization. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Formatting", "type": { "text": "Story" }, "default": "{ args: { columns: Feedback.Columns, data: Feedback.Data, }, parameters: { docs: { description: { story: ` **Column justification**
    Default alignment is left (start), with options to justify content to the right (end), and supports space-between layouts.
    Example: in email columns where cell value and action buttons need clear distinction and consistent alignment across rows. --- **Column width and wrapping**
    Columns can have custom width. When width is set, content will wrap within the cell. --- **Cell vertical alignment**
    Cells can be vertically aligned to start (default centered). Recommended to align to start when long or wrapped content is present, ensuring consistent top alignment for labels or values across rows. --- **Sortable columns**
    When justified to the right, sorting indicator appears on the left. Column label positioned to the right of the indicator. `, }, }, }, render: (args) => html` `, }" }, { "kind": "variable", "name": "Actions", "type": { "text": "Story" }, "default": "{ args: { columns: ActionsData.Columns, actions: ActionsData.MultipleActions, data: ActionsData.Data, }, parameters: { docs: { description: { story: ` The \\`actions\\` property defines row interactions shown as the last cell of each row. Supports all cell types (button, link, context-menu, badge, etc.) and can contain multiple actions. When passed as an object \\`{ label, align, justify, sticky }\\`, it configures the actions column header and cell layout. The actual action content is provided through named slots using the \\`actions:rowKey:main\\` convention. #### Sticky Actions Set \\`sticky: true\\` on the actions configuration to pin the actions column to the right edge of the table during horizontal scrolling. This ensures action buttons remain accessible even when the table content overflows horizontally. `, }, }, }, render: (args) => { const multiRef = createRef() const ctxRef = createRef() const linkRef = createRef() return html` { const table = multiRef.value if (table) render(ActionsData.MultipleActionsSlotContent(e.detail.rows), table) }} >


    { const table = ctxRef.value if (table) render( ActionsData.ActionContextMenuSlotContent(e.detail.rows), table, ) }} >


    { const table = linkRef.value if (table) render(ActionsData.ActionLinkSlotContent(e.detail.rows), table) }} > ` }, }" }, { "kind": "variable", "name": "Tfoot", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, actions: Users.Actions, density: 'comfortable', variant: 'neutral-02-outlined' as Variant, data: Users.Data, tfoot: Users.Tfoot, selectable: true, searchable: true, searchLabel: 'Search users', settings: true, plain: false, height: '80vh', responsive: false, nocache: false, striped: false, }, parameters: { docs: { description: { story: ` The \\`tfoot\\` property adds a \\`\\` footer row at the bottom of the table for displaying aggregated values (sums, averages, counts, etc.). The footer row is fully slot-based, the table provides insertion points for each visible column and you decide what to render (formatted numbers, badges, text, or nothing). When a \\`label\\` is provided, the first cell renders as a \\`\\` for proper accessibility semantics. #### Configuration \\`\\`\\`typescript const tfoot = { label: 'Total', // Label shown in the first cell (renders as ) sticky: true, // Pin to the bottom of the scroll area } \\`\\`\\` #### Slot Convention Table footer slots use the naming pattern \\`tfoot:{columnKey}\\`: \\`\\`\\`html \\${count} active \\`\\`\\` Compute your aggregation in the \\`gds-table-data-loaded\\` handler and render slot content into the table. When \\`sticky: true\\`, the footer stays pinned to the bottom of the scroll area combined with the sticky header, this creates a fixed frame around the scrollable data. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render( html`${Users.SlotContent(e.detail.rows)} ${Users.TfootSlotContent(e.detail.rows)}`, table, ) } return html` ` }, }" }, { "kind": "variable", "name": "Headline", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, headline: 'User Management', headlineTag: 'h2', summary: 'Overview of all users in the system', }, parameters: { docs: { description: { story: ` When the \\`headline\\` and \\`summary\\` properties are set, they will be displayed at the top of the table. You can change the \\`headline-tag\\` to any valid heading tag (e.g., 'h1-h5') to customize the semantic structure without altering the appearance. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Plain", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, plain: true, }, parameters: { docs: { description: { story: ` When \\`plain\\` boolean is set, the table header and footer are removed, rendering only the data table. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Striped", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, striped: true, density: 'compact', }, parameters: { docs: { description: { story: ` When \\`striped\\` boolean is set, alternating row background colors are applied to even-numbered rows. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Density", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, density: 'compact', headline: 'User Management', summary: 'Overview of all users in the system', }, parameters: { docs: { description: { story: ` The \\`density\\` property controls the table's visual spacing and affects the table's **built-in UI** (search input, column settings dropdown, pagination). - **\\`comfortable\\`** (Default) · Standard spacing for balanced readability - **\\`compact\\`** · Reduced spacing to maximize information density - **\\`spacious\\`** · Increased spacing for enhanced readability > **Slot content sizing** The density mode does **not** automatically resize components you provide via slots. When using a specific density, size your slotted components accordingly. For example, use \\`size=\"small\"\\` on badges and buttons in \\`compact\\` or \\`comfortable\\` mode, and \\`size=\"medium\"\\` in \\`spacious\\` mode to maintain visual consistency. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Variant", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, variant: 'neutral-02-outlined' as Variant, density: 'comfortable', }, argTypes: { variant: { control: 'select', options: [ 'neutral-01', 'neutral-01-2', 'neutral-02', 'neutral-02-2', 'neutral-02-outlined', 'brand-01', 'brand-02', ] as Variant[], }, }, parameters: { docs: { description: { story: ` The \\`variant\\` property controls the visual style of the table container card. Available variants: \\`neutral-01\\`, \\`neutral-01-2\\`, \\`neutral-02\\`, \\`neutral-02-2\\`, \\`neutral-02-outlined\\` (Default), \\`brand-01\\`, \\`brand-02\\` `, }, }, }, render: (args) => { const wrapperVariant = args.variant === 'tertiary' ? 'primary' : 'tertiary' const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Responsive", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, responsive: true, }, parameters: { docs: { description: { story: ` When the \\`responsive\\` boolean is set to \\`true\\`, the table transforms its layout for smaller screens: - **Mobile Layout**: Rows are restructured into a card-like format - **Column Presentation**: - Column names are displayed on the left side - Corresponding cell values are shown on the right side - **Header Behavior**: On larger screens table header becomes sticky, ensuring column labels remain visible during scrolling. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Slots", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, }, parameters: { docs: { description: { story: ` Use slots to add custom controls to the table header, footer, and content areas. - **header-lead**: Add filtering/sorting controls at the start of the header. - **header-trail**: Add actions (e.g., export buttons) at the end of the header. - **footer**: Replace the default pagination footer with custom content. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` Sorting Sort by Name Sort by Status Export ` }, }" }, { "kind": "variable", "name": "StateSlots", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, simulatedState: 'normal', }, argTypes: { simulatedState: { control: 'select', options: ['normal', 'error', 'empty', 'no-results'], description: 'Simulate different table states', }, }, parameters: { docs: { description: { story: ` Override default error, empty, and no-results states with custom content. - **error**: Displayed when data loading fails. - **empty**: Displayed when no data is available. - **no-results**: Displayed when search returns no results. Each slot provides a default fallback if not specified. Use the **Simulated State** control below to switch between states. `, }, }, }, render: (args) => { const tableRef = createRef() const dataProvider = async (request: any) => { await new Promise((resolve) => setTimeout(resolve, 500)) if (args.simulatedState === 'error') { throw new Error('Simulated error state') } if (args.simulatedState === 'empty') { return { rows: [], total: 0 } } if (args.simulatedState === 'no-results') { return { rows: [], total: 0 } } return args.data(request) } const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } const handleRetry = () => { args.simulatedState = 'normal' if (tableRef.value) { tableRef.value.dataLoadKey = `retry-${Date.now()}` } } const handleClearSearch = () => { args.simulatedState = 'normal' if (tableRef.value) { tableRef.value.dataLoadKey = `clear-${Date.now()}` const searchInput = tableRef.value.shadowRoot?.querySelector('gds-input') if (searchInput) { searchInput.value = '' } } } // Simulate search query for no-results state setTimeout(() => { if (args.simulatedState === 'no-results' && tableRef.value) { const searchInput = tableRef.value.shadowRoot?.querySelector('gds-input') if (searchInput) { searchInput.value = 'test search' searchInput.dispatchEvent(new Event('input', { bubbles: true })) } } }, 100) return html` Unable to load data An error occurred while loading the data. Please try again. Retry No data available There are currently no records to display in this table. No search results Your search did not match any records. Try different keywords. Clear search ` }, }" }, { "kind": "variable", "name": "SlotComposition", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, headline: 'User Management', summary: 'Overview of all users in the system', selectable: true, searchable: true, settings: true, density: 'comfortable', }, parameters: { docs: { description: { story: ` Slot composition lets you render custom components inside table cells using standard web component slots. Each row needs a **unique key** for slot naming set via the \\`key\\` parameter in \\`Slot()\\`, or it falls back to \\`row.id\\`, then the row index. #### 1. Compose data with \\`Slot()\\` \\`\\`\\`ts // With explicit unique key (value, slots, key) const data = users.map(row => ({ ...row, name: Slot(row.name, ['avatar', 'value'], row.accountId), email: Slot(row.email, ['value', 'copy-button'], row.accountId), status: Slot(row.status, ['status'], row.accountId), })) // Without key - falls back to row.id, then row index const data = users.map(row => ({ ...row, name: Slot(row.name, ['avatar', 'value']), email: Slot(row.email, ['value', 'copy-button']), status: Slot(row.status, ['status']), })) \\`\\`\\` The arguments are positional: \\`Slot(value, slots, key)\\` or \\`Slot(value, key, slots)\\`. The **value** is used for sorting/search, **slots** is an ordered array of slot ids (include \\`'value'\\` to render the plain text alongside your components), and **key** is an optional \\`string | number\\` used as a stable row identifier. #### 2. Render slot content on data load \\`\\`\\`ts @gds-table-data-loaded=\\${(e) => { render(slotContent(e.detail.rows), tableEl) }} \\`\\`\\` #### 3. Slot naming convention The slot name follows the pattern \\`columnKey:rowKey:slotId\\`. \\`\\`\\`html Active Active Active \\`\\`\\` Only the current page's slot content is rendered - previous elements are replaced on page change. > See the **Developer Guide** for full details on framework integration and the \\`Slot()\\` API. `, }, }, }, render: (args) => { const tableRef = createRef() const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } return html` ` }, }" }, { "kind": "variable", "name": "Events", "type": { "text": "Story" }, "default": "{ args: { columns: Users.Columns, data: Users.Data, }, parameters: { docs: { description: { story: ` The table component dispatches events for various user interactions. **Pagination Events** - **gds-page-change**: Fired when the active page changes. Detail: \\`{ page: number }\\` - **gds-rows-change**: Fired when the rows per page value changes. Detail: \\`{ rows: number }\\` **Sorting Events** - **gds-sort-change**: Fired when sorting changes. Detail: \\`{ sortColumn: string, sortDirection: 'asc' | 'desc' }\\` **Data Events** - **gds-table-data-loaded**: Fired when data is successfully loaded - **gds-table-data-error**: Fired when data loading fails - **gds-table-selection**: Fired when row selection changes This example demonstrates listening to pagination and sorting events and displaying the current state. `, }, }, }, render: (args) => { const tableRef = createRef() const state = { currentPage: 1, currentRows: 10, sortColumn: '', sortDirection: 'asc', } const handleDataLoaded = (e: CustomEvent) => { const table = tableRef.value if (table) render(Users.SlotContent(e.detail.rows), table) } const handlePageChange = (e: CustomEvent) => { console.log('🔔 Page change event:', e.detail) state.currentPage = e.detail.page const pageEl = document.querySelector('#page-status') if (pageEl) { pageEl.textContent = `Page: ${state.currentPage}` } } const handleRowsChange = (e: CustomEvent) => { console.log('🔔 Rows change event:', e.detail) state.currentRows = e.detail.rows const rowsEl = document.querySelector('#rows-status') if (rowsEl) { rowsEl.textContent = `Rows: ${state.currentRows}` } } const handleSortChange = (e: CustomEvent) => { console.log('🔔 Sort change event:', e.detail) state.sortColumn = e.detail.sortColumn state.sortDirection = e.detail.sortDirection const sortEl = document.querySelector('#sort-status') if (sortEl) { sortEl.textContent = `${state.sortColumn} (${state.sortDirection})` } } return html` Event Monitor Open your browser console (F12) to see event logs Current Page Page: ${state.currentPage} Rows Per Page Rows: ${state.currentRows} Sort Column ${state.sortColumn ? `${state.sortColumn} (${state.sortDirection})` : 'None'} handlePageChange(e)} @gds-rows-change=${(e: CustomEvent) => handleRowsChange(e)} @gds-sort-change=${(e: CustomEvent) => handleSortChange(e)} > ` }, }" }, { "kind": "variable", "name": "EdgeCase", "type": { "text": "Story" }, "default": "{ args: { rows: 8, options: [8, 20], }, parameters: { docs: { description: { story: ` Demonstrates a pagination edge case where the selected page size exceeds the total number of rows. 1. Dataset has 13 rows total 2. Initial page size is 8 3. Change rows per page to 20 In this edge case, page navigation is hidden when only one page remains, while the rows-per-page selector stays visible so users can switch back to a smaller page size. `, }, }, }, render: (args) => { const columns = [ { key: 'id', label: 'ID', sortable: true }, { key: 'name', label: 'Name', sortable: true }, { key: 'status', label: 'Status', sortable: true }, ] const rows = Array.from({ length: 13 }, (_, i) => ({ id: i + 1, name: `User ${i + 1}`, status: i % 2 === 0 ? 'Active' : 'Inactive', })) const dataProvider = async (request: any) => { const start = (request.page - 1) * request.rows const end = start + request.rows return { rows: rows.slice(start, end), total: rows.length, } } return html` ` }, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Overview", "declaration": { "name": "Overview", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Selection", "declaration": { "name": "Selection", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Filtering", "declaration": { "name": "Filtering", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Caching", "declaration": { "name": "Caching", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Sorting", "declaration": { "name": "Sorting", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Cell", "declaration": { "name": "Cell", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Formatting", "declaration": { "name": "Formatting", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Actions", "declaration": { "name": "Actions", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Tfoot", "declaration": { "name": "Tfoot", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Headline", "declaration": { "name": "Headline", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Plain", "declaration": { "name": "Plain", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Striped", "declaration": { "name": "Striped", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Density", "declaration": { "name": "Density", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Variant", "declaration": { "name": "Variant", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Responsive", "declaration": { "name": "Responsive", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Slots", "declaration": { "name": "Slots", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "StateSlots", "declaration": { "name": "StateSlots", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "SlotComposition", "declaration": { "name": "SlotComposition", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "Events", "declaration": { "name": "Events", "module": "src/components/table/table.stories.ts" } }, { "kind": "js", "name": "EdgeCase", "declaration": { "name": "EdgeCase", "module": "src/components/table/table.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/table/table.styles.ts", "declarations": [ { "kind": "variable", "name": "TableStyles", "default": "css` /* Host & Container */ :host { display: block; font: var(--gds-sys-text-detail-s-book); color: var(--gds-sys-color-content-neutral-01); text-align: left; --_table-height: 80vh; --_table-border-width: var(--gds-sys-space-5xs); --_table-border-color: var(--gds-sys-color-border-neutral-02); } /* Density Modes */ /* Compact density */ .table.compact { --table-cell-padding-y: var(--gds-sys-space-xs); --table-cell-padding-x: var(--gds-sys-space-s); --table-header-padding-y: var(--gds-sys-space-xs); --table-header-padding-x: var(--gds-sys-space-s); --table-row-min-height: var(--gds-sys-space-xl); --table-font-size: var(--gds-sys-text-detail-s-book); --table-gap: var(--gds-sys-space-m); --table-border-spacing: 0 var(--gds-sys-space-5xs); --table-data-padding: var(--gds-sys-space-5xs) var(--gds-sys-space-4xs); --table-data-padding-x: var(--gds-sys-space-4xs); } /* Comfortable default */ .table.comfortable { --table-cell-padding-y: var(--gds-sys-space-s); --table-cell-padding-x: var(--gds-sys-space-m); --table-header-padding-y: var(--gds-sys-space-s); --table-header-padding-x: var(--gds-sys-space-m); --table-row-min-height: var(--gds-sys-space-4xl); --table-font-size: var(--gds-sys-text-detail-s-book); --table-gap: var(--gds-sys-space-l); --table-border-spacing: 0 var(--gds-sys-space-4xs); --table-data-padding: var(--gds-sys-space-3xs) var(--gds-sys-space-2xs); --table-data-padding-x: var(--gds-sys-space-2xs); } /* Spacious density */ .table.spacious { --table-cell-padding-y: var(--gds-sys-space-l); --table-cell-padding-x: var(--gds-sys-space-l); --table-header-padding-y: var(--gds-sys-space-l); --table-header-padding-x: var(--gds-sys-space-l); --table-row-min-height: var(--gds-sys-space-5xl); --table-font-size: var(--gds-sys-text-detail-m-book); --table-gap: var(--gds-sys-space-xl); --table-border-spacing: 0 var(--gds-sys-space-3xs); --table-data-padding: var(--gds-sys-space-3xs) var(--gds-sys-space-xs); --table-data-padding-x: var(--gds-sys-space-xs); } /* Neutral 02 variants */ .data.variant-neutral-02, .data.variant-neutral-02-outlined { --_table-header-bg: var(--gds-sys-color-l2-neutral-01); --_table-header-hover: var(--gds-sys-color-l3-neutral-02); --_table-header-active: var(--gds-sys-color-l3-neutral-03); --_table-row-hover: var(--gds-sys-color-l2-neutral-01); --_table-row-selected-hover: var(--gds-sys-color-l3-neutral-03-2); --_table-row-striped: var(--gds-sys-color-l2-neutral-01); --_table-card-bg: var(--gds-sys-color-l1-neutral-01); } /* Neutral 01 variant */ .data.variant-neutral-01 { --_table-header-bg: var(--gds-sys-color-l2-neutral-02); --_table-header-hover: var(--gds-sys-color-l3-neutral-02); --_table-header-active: var(--gds-sys-color-l3-neutral-03); --_table-row-hover: color-mix( in srgb, var(--gds-sys-color-l3-neutral-02), var(--gds-sys-color-state-neutral-01) ); --_table-row-selected-hover: var(--gds-sys-color-l3-neutral-01-2); --_table-row-striped: var(--gds-sys-color-l2-neutral-01); --_table-card-bg: var(--gds-sys-color-l2-neutral-01); } /* Apply density variables */ .table { display: flex; flex-direction: column; gap: var(--table-gap); font: var(--table-font-size); width: 100%; } /* Container that enables horizontal scroll */ .data { width: 100%; overflow-x: auto; overflow-y: auto; max-height: var(--_table-height); box-sizing: border-box; padding: var(--table-data-padding); position: relative; border-radius: var(--gds-sys-radius-m); } .data:focus { outline: none; } .table-card { outline-color: transparent; outline-offset: var(--gds-sys-space-4xs); outline-style: solid; outline-width: var(--gds-sys-space-4xs); } .table-card:has(.data:focus-visible) { outline-color: var(--gds-sys-color-content-neutral-01); } .table-card:has(.data:focus-within:not(:focus-visible)) { outline-color: transparent; } table { width: max-content; min-width: 100%; table-layout: auto; border: none; border-collapse: separate; border-spacing: var(--table-border-spacing); } tbody td { font-weight: normal; padding-block: var(--table-cell-padding-y); padding-inline: var(--table-cell-padding-x); } thead tr th:first-child, tbody tr:hover td:first-child, tbody tr.selected td:first-child, .striped tbody tr td:first-child { border-top-left-radius: var(--gds-sys-radius-s); border-bottom-left-radius: var(--gds-sys-radius-s); } thead tr th:last-child, tbody tr:hover td:last-child, tbody tr.selected td:last-child, .striped tbody tr td:last-child { border-top-right-radius: var(--gds-sys-radius-s); border-bottom-right-radius: var(--gds-sys-radius-s); } /* Table Header */ thead tr th { padding-block: var(--gds-sys-space-3xs); background: var(--_table-header-bg); } thead th.sortable { cursor: pointer; user-select: none; } /* Column header content layout */ .column-header { display: flex; align-items: center; position: relative; justify-content: space-between; min-height: var(--gds-sys-space-l); gap: var(--table-gap); padding: calc(var(--table-cell-padding-y) / 2) var(--table-cell-padding-x); border-radius: var(--gds-sys-radius-xs); transition: all var(--gds-sys-motion-duration-fast); } th.sortable .column-header:hover { background-color: var(--_table-header-hover); } th.sortable:active .column-header { background-color: var(--_table-header-active); } .column-label { font-weight: var(--gds-sys-text-weight-book); } .sort-icon { display: flex; align-items: center; justify-content: center; transition-property: opacity; transition-duration: var(--gds-sys-motion-duration-fast); transition-timing-function: var(--gds-sys-motion-easing-ease); opacity: 0; } @media (hover: hover) and (min-width: 768px) { thead th.sortable:hover:not(.sorted) .sort-icon { opacity: 0.8; } } thead th.sorted .sort-icon { opacity: 1; } /* Table Body */ tbody tr td { border-top-style: solid; border-top-width: var(--_table-border-width); border-top-color: var(--_table-border-color); } tbody tr.loading { opacity: 0.3; pointer-events: none; } tbody tr.loading:not(:first-child) td { border-color: var(--gds-sys-color-border-neutral-03); } /* Row Selection */ .checkbox-cell { min-width: var(--gds-sys-space-l); width: var(--gds-sys-space-l); max-width: var(--gds-sys-space-l); padding: var(--table-cell-padding-y) var(--table-cell-padding-x); } tbody tr:hover td, tbody tr.selected td, tbody tr:first-child td { border-color: transparent; } tbody tr:hover + tr td, tbody tr.selected + tr td { border-color: transparent; } tbody tr.selected:last-child td { border-bottom-color: transparent; } tbody tr.selected { background-color: var(--gds-sys-color-l3-neutral-02); } @media (hover: hover) and (min-width: 768px) { tbody tr.selected:hover { background-color: var(--_table-row-selected-hover); } tbody tr:hover:not(.selected) { background-color: var(--_table-row-hover); } } tbody tr:hover, tbody tr:hover + tr { border-color: transparent; } /* Striped */ .striped tbody tr:not(.selected, :hover):nth-child(even) td { background-color: var(--_table-row-striped); } .striped tbody tr td { border-color: transparent; } /* Header & Footer Layout */ .header { display: flex; justify-content: space-between; transition-property: opacity, translate; transition-duration: var(--gds-sys-motion-duration-fast); transition-timing-function: var(--gds-sys-motion-easing-ease); @starting-style { opacity: 0; translate: 0 -2px; } } /* Shared layout for header and footer sections */ .header .lead, .header .trail { display: flex; align-items: center; gap: calc(var(--table-gap) * 0.8); width: max-content; } /* Cell Content & Alignment */ .cell-content { width: 100%; height: 100%; display: flex; align-items: center; gap: 10px; } /* Wrapping utilities */ td.wrap .cell-content { white-space: normal; word-wrap: break-word; overflow-wrap: break-word; } td.wrap, th.wrap { width: var(--cell-width); } /* Justify utilities */ .justify-start .cell-content { text-align: left; justify-content: start; } .justify-center .cell-content { text-align: center; justify-content: center; } .justify-space-between .cell-content { text-align: left; justify-content: space-between; } .justify-end .cell-content { text-align: right; justify-content: flex-end; } .justify-end:not(.sortable) .column-header { text-align: right; justify-content: flex-end; } .sortable.justify-end .column-header { flex-direction: row-reverse; } th.actions { padding-inline: 0; } th.actions.justify-end .column-header { justify-content: flex-end; } /* Sticky actions column */ th.actions.sticky, td.actions-cell.sticky { position: sticky; right: calc(-1 * var(--table-data-padding-x, 0px)); z-index: 1; width: max-content; padding-right: calc( var(--table-cell-padding-x) + var(--table-data-padding-x, 0px) ); } th.actions.sticky { z-index: 2; background: var(--_table-header-bg); } th.actions.sticky .column-header { justify-content: flex-end; } td.actions-cell.sticky { background: var(--_table-card-bg); } td.actions-cell.sticky .cell-content { justify-content: flex-end; position: relative; } /* Left gradient fade on sticky action cells */ td.actions-cell.sticky::before { content: ''; position: absolute; inset-block: 0; right: 100%; width: var(--gds-sys-space-4xl); pointer-events: none; background: linear-gradient(to right, transparent, var(--_table-card-bg)); } th.actions.sticky::before { content: ''; position: absolute; inset-block: 0; right: 100%; width: var(--gds-sys-space-4xl); pointer-events: none; background: linear-gradient(to right, transparent, var(--_table-header-bg)); } /* Sticky action inherits row hover/selected/striped backgrounds */ tbody tr:hover td.actions-cell.sticky { background: var(--_table-row-hover); } tbody tr:hover td.actions-cell.sticky::before { background: linear-gradient(to right, transparent, var(--_table-row-hover)); } tbody tr.selected td.actions-cell.sticky { background: var(--gds-sys-color-l3-neutral-02); } tbody tr.selected td.actions-cell.sticky::before { background: linear-gradient( to right, transparent, var(--gds-sys-color-l3-neutral-02) ); } tbody tr.selected:hover td.actions-cell.sticky { background: var(--_table-row-selected-hover); } tbody tr.selected:hover td.actions-cell.sticky::before { background: linear-gradient( to right, transparent, var(--_table-row-selected-hover) ); } .striped tbody tr:not(.selected, :hover):nth-child(even) td.actions-cell.sticky { background: var(--_table-row-striped); } .striped tbody tr:not(.selected, :hover):nth-child(even) td.actions-cell.sticky::before { background: linear-gradient( to right, transparent, var(--_table-row-striped) ); } /* Table Footer Row */ tfoot.tablefoot tr td, tfoot.tablefoot tr th[scope='row'] { padding-block: var(--table-cell-padding-y); padding-inline: var(--table-cell-padding-x); background: var(--_table-header-bg); font-weight: normal; border-top: var(--_table-border-width) solid var(--_table-border-color); } tfoot.tablefoot tr th[scope='row'] { font-weight: var(--gds-sys-text-weight-book); } tfoot.tablefoot tr td:first-child, tfoot.tablefoot tr th:first-child { border-top-left-radius: var(--gds-sys-radius-s); border-bottom-left-radius: var(--gds-sys-radius-s); } tfoot.tablefoot tr td:last-child, tfoot.tablefoot tr th:last-child { border-top-right-radius: var(--gds-sys-radius-s); border-bottom-right-radius: var(--gds-sys-radius-s); } .tablefoot-label { font-weight: var(--gds-sys-text-weight-book); white-space: nowrap; } tfoot.tablefoot.sticky { position: sticky; bottom: 0; z-index: 10; will-change: transform; } /* When sticky tablefoot: move padding from .data to table, keep tfoot edge-to-edge */ .data:has(tfoot.tablefoot.sticky) { padding: 0; } .data:has(tfoot.tablefoot.sticky) table { padding-top: var(--table-data-padding-x); padding-inline: var(--table-data-padding-x); } tfoot.tablefoot.sticky tr td, tfoot.tablefoot.sticky tr th[scope='row'] { border-radius: 0; background: var(--_table-card-bg); border-top: var(--_table-border-width) solid var(--_table-border-color); } /* Align utilities */ td { height: 100%; } .align-start { vertical-align: top; } .align-end { vertical-align: bottom; } .align-center { vertical-align: middle; } .align-start .cell-content { align-items: start; } .align-center .cell-content { align-items: center; } .align-stretch .cell-content { align-items: stretch; } .align-end .cell-content { align-items: end; } /* Responsive Design */ @media (max-width: 760px) { .responsive.data { display: contents; } .responsive table { max-width: 100%; } .responsive thead { position: sticky; top: var(--gds-sys-space-s); z-index: 2; border-radius: var(--gds-sys-radius-s); } .responsive thead { display: none; } .responsive tbody { display: flex; flex-direction: column; gap: var(--table-gap); } .responsive tbody tr { display: flex; flex-direction: column; padding: var(--table-cell-padding-x); border: var(--gds-sys-space-5xs) solid var(--gds-sys-color-border-neutral-02); border-radius: var(--gds-sys-space-s); margin: 0; } .responsive tbody tr:hover, .responsive tbody tr:hover + tr { border-color: var(--gds-sys-color-border-neutral-02); } .responsive tr.selected { border-color: transparent; } .responsive td { width: 100%; max-width: 100%; box-sizing: border-box; display: flex; justify-content: flex-start; align-items: center; padding: var(--gds-sys-space-xs) 0; border: none; } .responsive td .column-label { text-align: left; flex: 1; min-width: 0; } .responsive td .cell-content { justify-content: flex-start; flex: 1; width: 100%; gap: var(--gds-sys-space-s); } .responsive td .cell-wrapped-content { flex: 1; justify-content: flex-end; text-align: right; } .responsive tr:hover, .responsive tr td:hover { background: none; } } /* Medium screens: input and dropdown side by side */ @media (max-width: 760px) and (min-width: 480px) { .header { display: grid; grid-template-columns: 1fr 1fr; grid-template-areas: 'input dropdown' 'lead trail'; gap: calc(var(--table-gap) / 2); } .header .lead [gds-element='gds-input'] { grid-area: input; } .header .trail [gds-element='gds-dropdown'] { grid-area: dropdown; } .header .lead ::slotted(*:not([gds-element='gds-input'])) { grid-area: lead; } .header .trail ::slotted(*:not([gds-element='gds-dropdown'])) { grid-area: trail; } .header .lead, .header .trail { display: contents; } } /* Small screens: fully stacked */ @media (max-width: 479px) { .header { display: grid; grid-template-columns: 1fr; grid-template-areas: 'input' 'dropdown' 'lead' 'trail'; gap: calc(var(--table-gap) / 2); } .header .lead [gds-element='gds-input'] { grid-area: input; } .header .trail [gds-element='gds-dropdown'] { grid-area: dropdown; } .header .lead ::slotted(*:not([gds-element='gds-input'])) { grid-area: lead; } .header .trail ::slotted(*:not([gds-element='gds-dropdown'])) { grid-area: trail; } .header .lead, .header .trail { display: contents; } } /* Skeleton Loading State */ .skeleton { display: inline-block; background: linear-gradient( 90deg, var(--gds-sys-color-l3-neutral-01) 25%, var(--gds-sys-color-l2-neutral-01) 50%, var(--gds-sys-color-l3-neutral-01) 75% ); background-size: 200% 100%; animation: skeleton-shimmer 1.5s ease-in-out infinite; border-radius: var(--gds-sys-space-max); opacity: 0.1; } @keyframes skeleton-shimmer { 0% { background-position: 200% 0; } 100% { background-position: -200% 0; } } /* Skeleton elements */ .skeleton-text { height: 14px; width: 80%; min-width: 60px; } .skeleton-checkbox { height: 18px; width: 18px; border-radius: var(--gds-sys-radius-3xs); } .skeleton-action { height: 24px; width: 24px; border-radius: var(--gds-sys-radius-max); } /* Skeleton row styling */ .skeleton-row { opacity: 1; pointer-events: none; } .skeleton-row td { padding: var(--table-cell-padding-y) var(--table-cell-padding-x); } /* Different skeleton text widths for more natural look */ .skeleton-row:nth-child(odd) .skeleton-text { width: 70%; } .skeleton-row:nth-child(3n) .skeleton-text { width: 90%; } .skeleton-row:nth-child(4n) .skeleton-text { width: 60%; } /* Visually hidden - screen reader only without layout impact */ .visually-hidden { clip: rect(0 0 0 0); clip-path: inset(50%); overflow: hidden; white-space: nowrap; height: 0px; width: 0px; } /* Scroll driven animation */ @supports (animation-timeline: scroll()) { @media (prefers-reduced-motion: no-preference) { tbody tr { animation-name: ROW_ANIMATION_VERTICAL, ROW_ANIMATION_VERTICAL; animation-fill-mode: both; animation-timing-function: ease-in-out; animation-direction: normal, reverse; animation-timeline: view(block); animation-range: entry -40px, exit -40px; } @keyframes ROW_ANIMATION_VERTICAL { 0% { opacity: 0; filter: blur(12px); translate: 0 12px; } } thead { position: sticky; top: 4px; z-index: 10; transition: box-shadow 200ms ease; border-radius: var(--gds-sys-radius-s); will-change: transform; } thead { background-color: var(--gds-sys-color-l1-neutral-01); } .data.scrolled thead { box-shadow: var(--gds-sys-shadow-l-01), var(--gds-sys-shadow-l-02), inset 0 -4px 6px var(--gds-sys-color-l1-neutral-01); backdrop-filter: blur(8px); background: color-mix( in srgb, var(--gds-sys-color-l2-neutral-01), transparent 30% ); } @media (prefers-reduced-transparency: no-preference) { .data.scrolled thead tr th { background: transparent; } } /* Sticky table footer */ tfoot.tablefoot.sticky { background-color: var(--_table-card-bg); } tfoot.tablefoot.sticky tr td, tfoot.tablefoot.sticky tr th[scope='row'] { background: var(--_table-card-bg); } /* Horizontal scroll */ @property --_start-fade { syntax: ''; inherits: false; initial-value: 0; } @property --_end-fade { syntax: ''; inherits: false; initial-value: 0; } @keyframes scroll-fade { 0% { --_start-fade: 0px; --_end-fade: var(--gds-sys-space-4xl); } 1% { --_start-fade: var(--gds-sys-space-4xl); --_end-fade: var(--gds-sys-space-4xl); } 99% { --_start-fade: var(--gds-sys-space-4xl); --_end-fade: var(--gds-sys-space-4xl); } 100% { --_start-fade: var(--gds-sys-space-4xl); --_end-fade: 0px; } } .data { overflow-x: auto; mask: linear-gradient( to right, #0000, #ffff var(--_start-fade) calc(100% - var(--_end-fade)), #0000 ); animation: scroll-fade both linear; animation-timeline: scroll(self inline); } /* When sticky actions are present, remove the right fade.*/ .data:has(td.actions-cell.sticky) { mask: linear-gradient( to right, #0000, #ffff var(--_start-fade), #ffff 100% ); } } } @media (max-width: 760px) { .responsive, .responsive tbody tr { animation: none; } } @supports not (animation-timeline: scroll()) { tbody tr { will-change: opacity, filter, translate; transition: all 242ms cubic-bezier(0.22, 0.61, 0.36, 1); @starting-style { opacity: 0; filter: blur(20px); translate: 0 10px; } } } /* Scrollbar */ .data { --_scrollbar-color-thumb: var(--gds-sys-color-content-neutral-02); --_scrollbar-color-track: var(--gds-sys-color-l3-neutral-02); --_scrollbar-width: var(--gds-sys-space-2xs); } @supports (scrollbar-width: auto) { .data { scrollbar-color: var(--_scrollbar-color-thumb) transparent; scrollbar-width: var(--_scrollbar-width); } } @supports selector(::-webkit-scrollbar) { .data::-webkit-scrollbar { width: var(--_scrollbar-width); height: var(--_scrollbar-width); } .data::-webkit-scrollbar-track { background: transparent; } .data::-webkit-scrollbar-thumb { background: var(--_scrollbar-color-thumb); border-radius: var(--gds-sys-radius-max); } } /* Reduced motion */ @media (prefers-reduced-motion: reduce) { tbody tr, tbody td .cell-content, thead th .column-header, .sort-icon, .column-header, .header { transition: none; animation: none; } } `" } ], "exports": [ { "kind": "js", "name": "TableStyles", "declaration": { "name": "TableStyles", "module": "src/components/table/table.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/table/table.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsTable", "declaration": { "name": "GdsTable", "module": "src/components/table/table.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/table/table.types.ts", "declarations": [ { "kind": "variable", "name": "DENSITY_CONFIG", "type": { "text": "{\n compact: {\n input: 'small',\n dropdown: 'small',\n },\n comfortable: {\n input: 'small',\n dropdown: 'small',\n },\n spacious: {\n input: 'large',\n dropdown: 'medium',\n },\n}" }, "default": "{ compact: { input: 'small', dropdown: 'small', }, comfortable: { input: 'small', dropdown: 'small', }, spacious: { input: 'large', dropdown: 'medium', }, }", "description": "Internal density configuration for the table's built-in UI controls\n(search input, column settings dropdown). Does not affect user-provided\nslot content size your own components to match the chosen density." }, { "kind": "function", "name": "isSlotValue", "return": { "type": { "text": "value is SlotValue" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" } } ] }, { "kind": "function", "name": "Slot", "return": { "type": { "text": "SlotValue" } }, "parameters": [ { "name": "config", "type": { "text": "SlotValue" } } ] }, { "kind": "function", "name": "Slot", "return": { "type": { "text": "SlotValue" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "unknown" } }, { "name": "slots", "optional": true, "type": { "text": "string[]" } }, { "name": "key", "optional": true, "type": { "text": "string | number" } } ] }, { "kind": "function", "name": "Slot", "return": { "type": { "text": "SlotValue" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "unknown" } }, { "name": "key", "optional": true, "type": { "text": "string | number" } }, { "name": "slots", "optional": true, "type": { "text": "string[]" } } ] }, { "kind": "function", "name": "Slot", "return": { "type": { "text": "SlotValue" } }, "parameters": [ { "name": "valueOrConfig", "optional": true, "type": { "text": "unknown | SlotValue" } }, { "name": "slotsOrKey", "default": "['value']", "type": { "text": "string[] | string | number" } }, { "name": "keyOrSlots", "optional": true, "type": { "text": "string[] | string | number" } } ] } ], "exports": [ { "kind": "js", "name": "DENSITY_CONFIG", "declaration": { "name": "DENSITY_CONFIG", "module": "src/components/table/table.types.ts" } }, { "kind": "js", "name": "isSlotValue", "declaration": { "name": "isSlotValue", "module": "src/components/table/table.types.ts" } }, { "kind": "js", "name": "Slot", "declaration": { "name": "Slot", "module": "src/components/table/table.types.ts" } }, { "kind": "js", "name": "Slot", "declaration": { "name": "Slot", "module": "src/components/table/table.types.ts" } }, { "kind": "js", "name": "Slot", "declaration": { "name": "Slot", "module": "src/components/table/table.types.ts" } }, { "kind": "js", "name": "Slot", "declaration": { "name": "Slot", "module": "src/components/table/table.types.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/text/default-typography.styles.ts", "declarations": [ { "kind": "variable", "name": "defaultStyles", "default": "css` @layer defaults { a:link { color: currentColor; text-underline-offset: 0.1lh; font-weight: var(--gds-sys-text-weight-book); } a:visited { color: currentColor; } h1 { font: var(--gds-sys-text-heading-xl); } h2 { font: var(--gds-sys-text-heading-l); } h3 { font: var(--gds-sys-text-heading-m); } h4 { font: var(--gds-sys-text-heading-s); } h5 { font: var(--gds-sys-text-heading-xs); } h6 { font: var(--gds-sys-text-heading-xs); } p, li { font: var(--gds-sys-text-body-m-regular); } strong { font-weight: var(--gds-sys-text-weight-medium); } } `" } ], "exports": [ { "kind": "js", "name": "defaultStyles", "declaration": { "name": "defaultStyles", "module": "src/components/text/default-typography.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/text/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/text/text" } } ] }, { "kind": "javascript-module", "path": "src/components/text/text.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsText", "members": [ { "kind": "field", "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "attribute": "tag" }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-transform'", "type": { "text": "string | undefined" }, "description": "Controls the text-transform property of the text.\nSupports all valid CSS text-transform values." }, { "kind": "field", "name": "'text-decoration'", "type": { "text": "string | undefined" }, "description": "Controls the text-decoration property of the inner element.\nSupports all valid CSS text-decoration values." }, { "kind": "field", "name": "lines", "type": { "text": "number | undefined" }, "description": "Controls the number of lines it should show." }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "fieldName": "tag" }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsDiv", "module": "/src/components/div/div.component" }, "tagName": "gds-text", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsText", "declaration": { "name": "GdsText", "module": "src/components/text/text.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/text/text.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Text', component: 'gds-text', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-text'), }, }", "description": "`gds-text` extends `gds-div` and adds the ability to set an internal tag name, such as `h1`, `h2`, etc. It also adds line clamping and text decoration properties.\n\nStyle expression properties apply to the outer element unless otherwise specified." }, { "kind": "variable", "name": "Font", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Font', render: (args) => html` display-l body-m-regular detail-s-regular `, }", "description": "The `font` property controls the font style based on design tokens.\n\nFor all available font tokens, check out the [Studio on seb.io](https://seb.io/studio/typography)" }, { "kind": "variable", "name": "Tags", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Tags', render: (args) => html` Span ( Default ) Paragraph Em Mark strong small H1 H2 H3 H4 H5 H6 `, }", "description": "The `tag` property controls the inner element tag name.\n\nExample: `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `p`, `span`, `em`, `mark`, `strong`, `small` etc.\n\nDepending on which tag you use, different default styles will be applied. Style can be overridden using the `font`, `font-weight` and other style expression properties.\n\nThe default tag is `span` and the default size is `body-m`" }, { "kind": "variable", "name": "Heading", "type": { "text": "Story" }, "default": "{ name: 'Heading', render: (args) => html` H6: heading-xs H5: heading-xs H4: heading-s H3: heading-m H2: heading-l H1: heading-xl `, }", "description": "> Headings in the `gds-text` component come with predefined sizes based on design tokens, and the `tag` property is used to define the heading level.\n> For example, using `tag=\"h1\"` will automatically apply the `heading-xl` size, so specifying the `size` property is not necessary.\n> However, the `size` property can still be used to override the default size if needed.\n> This provides flexibility in using the `gds-text` component across different contexts while ensuring consistent typography." }, { "kind": "variable", "name": "Color", "type": { "text": "Story" }, "default": "{ name: 'Color', render: (args) => html` Color: Content 01 Color: Content Secondary Color: Content Tertiary `, }", "description": "\nThe `color` property that will change the text color based on the specified color token.\n\ne.g. ``" }, { "kind": "variable", "name": "Decoration", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Decoration', render: (args) => html` Underline Overline Line Through Dotted Wavy Underline `, }", "description": "The `text-decoration` property will change the text decoration based on the css values such as `underline`, `overline`, `line-through`, `underline dotted`, `{COLOR} wavy underline` etc.\n\n\ne.g.\n\n```html\n\n Wavy Underline\n \n```" }, { "kind": "variable", "name": "Lines", "type": { "text": "Story" }, "default": "{ name: 'Line Clamp', render: (args) => html` Lines:2 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lines:3 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lines:4 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "The `gds-text` component has a `lines` property that will clamp the text to the specified number of lines. It can be any number value." }, { "kind": "variable", "name": "TextWrap", "type": { "text": "Story" }, "default": "{ name: 'text-wrap', render: (args) => html` wrap Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. nowrap Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. pretty Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. balance Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. stable Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "\nCheck the documentation on `text-wrap` property [here](https://developer.mozilla.org/en-US/docs/Web/CSS/text-wrap)\n\nThe `text-wrap` property will change the text wrapping behavior based on the css values such as `wrap`, `nowrap`, `pretty`, `balance`, `stable`.\n\ne.g.\n\n```html\n\n ...\n\n```" }, { "kind": "variable", "name": "OverflowWrap", "type": { "text": "Story" }, "default": "{ name: 'overflow-wrap', render: (args) => html` Normal Most words are short & don't need to break. But Antidisestablishmentarianism is long. The width is set to min-content, with a max-width of 11em. Anywhere Most words are short & don't need to break. But Antidisestablishmentarianism is long. The width is set to min-content, with a max-width of 11em. Break Word Most words are short & don't need to break. But Antidisestablishmentarianism is long. The width is set to min-content, with a max-width of 11em. `, }", "description": "\nCheck the documentation on `text-overflow` property [here](https://developer.mozilla.org/en-US/docs/Web/CSS/text-overflow)\n\nThe `text-overflow` property will change the text overflow behavior based on the css values such as `clip`, `ellipsis`, `string`.\n\ne.g.\n\n```html\n\n ...\n\n```" }, { "kind": "variable", "name": "WhiteSpace", "type": { "text": "Story" }, "default": "{ name: 'white-space', render: (args) => html` normal Most words are short & don't need to break. But Antidisestablishmentarianism is long. The width is set to min-content, with a max-width of 11em. pre Most words are short & don't need to break. But Antidisestablishmentarianism is long. The width is set to min-content, with a max-width of 11em. pre-wrap Most words are short & don't need to break. But Antidisestablishmentarianism is long. The width is set to min-content, with a max-width of 11em. Shorthand wrap Most words are short & don't need to break. But Antidisestablishmentarianism is long. The width is set to min-content, with a max-width of 11em. collapse Most words are short & don't need to break. But Antidisestablishmentarianism is long. The width is set to min-content, with a max-width of 11em. preserve nowrap Most words are short & don't need to break. But Antidisestablishmentarianism is long. The width is set to min-content, with a max-width of 11em. `, }", "description": "\nCheck the documentation on `white-space` property [here](https://developer.mozilla.org/en-US/docs/Web/CSS/white-space)\n\nThe `white-space` supports all valid CSS `white-space` values such as `wrap` `collapse` or combined `preserve nowrap` etc.\n\ne.g.\n\n```html\n\n ...\n\n```" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/text/text.stories.ts" } }, { "kind": "js", "name": "Font", "declaration": { "name": "Font", "module": "src/components/text/text.stories.ts" } }, { "kind": "js", "name": "Tags", "declaration": { "name": "Tags", "module": "src/components/text/text.stories.ts" } }, { "kind": "js", "name": "Heading", "declaration": { "name": "Heading", "module": "src/components/text/text.stories.ts" } }, { "kind": "js", "name": "Color", "declaration": { "name": "Color", "module": "src/components/text/text.stories.ts" } }, { "kind": "js", "name": "Decoration", "declaration": { "name": "Decoration", "module": "src/components/text/text.stories.ts" } }, { "kind": "js", "name": "Lines", "declaration": { "name": "Lines", "module": "src/components/text/text.stories.ts" } }, { "kind": "js", "name": "TextWrap", "declaration": { "name": "TextWrap", "module": "src/components/text/text.stories.ts" } }, { "kind": "js", "name": "OverflowWrap", "declaration": { "name": "OverflowWrap", "module": "src/components/text/text.stories.ts" } }, { "kind": "js", "name": "WhiteSpace", "declaration": { "name": "WhiteSpace", "module": "src/components/text/text.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/text/text.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { display: block; } [tag] { margin: 0; padding: 0; text-underline-offset: 0.2lh; } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/text/text.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/text/text.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsText", "declaration": { "name": "GdsText", "module": "src/components/text/text.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/textarea/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/textarea/textarea" } } ] }, { "kind": "javascript-module", "path": "src/components/textarea/textarea.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsTextarea", "slots": [ { "description": "Accepts `gds-icon-[ICON_NAME]`. Use this to place an icon in the start of the field.", "name": "lead" }, { "description": "Accepts `gds-badge`. Use this to place a badge in the field, for displaying currency for example.", "name": "trail" }, { "description": "A longer supporting text can be placed here. It will be displayed in a panel when the user clicks the info button.", "name": "extended-supporting-text" } ], "events": [ { "description": "Fired when the clear button is clicked.", "name": "gds-input-cleared" }, { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" }, "tagName": "gds-textarea", "customElement": true, "summary": "A custom input element that can be used in forms.", "members": [ { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "rows", "type": { "text": "number" }, "default": "4", "description": "Rows of the textarea", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "supportingText", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field itself", "attribute": "supporting-text", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field should be clearable or not. Clearable fields will display a clear button when\nthe field has a value.", "attribute": "clearable", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "resizable", "type": { "text": "'auto' | 'manual' | 'false'" }, "default": "'auto'", "description": "The resizable attribute of the textarea. It can be set to 'auto', 'manual' or 'false'.\nWhen set to 'auto', the textarea will be resizable in the vertical direction based on content.\nWhen set to 'manual', the textarea will be resizable in both the vertical and horizontal directions.\nWhen set to 'false', the textarea will not be resizable.", "attribute": "resizable", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "showExtendedSupportingText", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "attribute": "show-extended-supporting-text", "reflects": true, "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "maxlength", "description": "The maximum number of characters allowed in the field.", "attribute": "maxlength", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size of texts.", "attribute": "size", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Hides the header and the footer, while still keeping the accessible label\n\nAlways set the `label` attribute, and if you need to hide it, add this attribute and keep `label` set.", "attribute": "plain", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "autocapitalize", "type": { "text": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'" }, "default": "'off'", "description": "Controls whether and how text input is automatically capitalized as it is entered by the user.", "attribute": "autocapitalize", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "autocorrect", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the browser's autocorrect feature is on or off.", "attribute": "autocorrect", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "autocomplete", "type": { "text": "string | undefined" }, "description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.", "attribute": "autocomplete", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "autofocus", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the input should receive focus on page load.", "attribute": "autofocus", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "spellcheck", "type": { "text": "boolean" }, "default": "true", "description": "Enables spell checking on the input.", "attribute": "spellcheck", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "wrap", "type": { "text": "'hard' | 'soft'" }, "description": "Indicates how the control should wrap the value for form submission. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/textarea#wrap) for available values.", "attribute": "wrap", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "enterkeyhint", "type": { "text": "| 'enter'\n | 'done'\n | 'go'\n | 'next'\n | 'previous'\n | 'search'\n | 'send' | undefined" }, "description": "Used to customize the label or icon of the Enter key on virtual keyboards.", "attribute": "enterkeyhint", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "inputmode", "type": { "text": "| 'none'\n | 'text'\n | 'decimal'\n | 'numeric'\n | 'tel'\n | 'search'\n | 'email'\n | 'url' | undefined" }, "description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.", "attribute": "inputmode", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "charCounterCallback", "default": "charCounterCallbackDefault", "description": "This callback allows for customization of the character counter. It should return a tuple\nwith the first value being the number of remaining characters, and the second value being\nthe variant of the badge. If the second value is `false`, no badge will be shown.", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "method", "name": "test_getClearButton", "description": "A reference to the clear button element. Returns null if there is no clear button.\nIntended for use in integration tests.", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "method", "name": "test_getFieldElement", "description": "A reference to the field element. This does not refer to the input element itself,\nbut the wrapper that makes up the visual field.\nIntended for use in integration tests.", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "method", "name": "select", "return": { "type": { "text": "void" } }, "description": "Selects all the text in the textarea element.", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "method", "name": "setRangeText", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "args", "type": { "text": "Parameters" } } ], "description": "Sets the value of the textarea element, replacing a range of text.", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "method", "name": "setSelectionRange", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "args", "type": { "text": "Parameters" } } ], "description": "Sets the start and end positions of a selection in the textarea element.", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "selectionStart", "description": "Sets the position of the start of the current text selection in the textarea element.", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "selectionEnd", "description": "Sets the position of the end of the current text selection in the textarea element.", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "selectionDirection", "description": "Sets the direction of the current text selection in the textarea element.", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "field", "name": "value", "description": "Get or set the value of the form control.", "attribute": "value", "type": { "text": "string" }, "default": "''", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "supporting-text", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field itself", "fieldName": "supportingText", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "clearable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field should be clearable or not. Clearable fields will display a clear button when\nthe field has a value.", "fieldName": "clearable", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "resizable", "type": { "text": "'auto' | 'manual' | 'false'" }, "default": "'auto'", "description": "The resizable attribute of the textarea. It can be set to 'auto', 'manual' or 'false'.\nWhen set to 'auto', the textarea will be resizable in the vertical direction based on content.\nWhen set to 'manual', the textarea will be resizable in both the vertical and horizontal directions.\nWhen set to 'false', the textarea will not be resizable.", "fieldName": "resizable", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "show-extended-supporting-text", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "fieldName": "showExtendedSupportingText", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "maxlength", "description": "The maximum number of characters allowed in the field.", "fieldName": "maxlength", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size of texts.", "fieldName": "size", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "plain", "type": { "text": "boolean" }, "default": "false", "description": "Hides the header and the footer, while still keeping the accessible label\n\nAlways set the `label` attribute, and if you need to hide it, add this attribute and keep `label` set.", "fieldName": "plain", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "autocapitalize", "type": { "text": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'" }, "default": "'off'", "description": "Controls whether and how text input is automatically capitalized as it is entered by the user.", "fieldName": "autocapitalize", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "autocorrect", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the browser's autocorrect feature is on or off.", "fieldName": "autocorrect", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "autocomplete", "type": { "text": "string | undefined" }, "description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.", "fieldName": "autocomplete", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "autofocus", "type": { "text": "boolean" }, "default": "false", "description": "Indicates that the input should receive focus on page load.", "fieldName": "autofocus", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "spellcheck", "type": { "text": "boolean" }, "default": "true", "description": "Enables spell checking on the input.", "fieldName": "spellcheck", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "wrap", "type": { "text": "'hard' | 'soft'" }, "description": "Indicates how the control should wrap the value for form submission. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/textarea#wrap) for available values.", "fieldName": "wrap", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "enterkeyhint", "type": { "text": "| 'enter'\n | 'done'\n | 'go'\n | 'next'\n | 'previous'\n | 'search'\n | 'send' | undefined" }, "description": "Used to customize the label or icon of the Enter key on virtual keyboards.", "fieldName": "enterkeyhint", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "inputmode", "type": { "text": "| 'none'\n | 'text'\n | 'decimal'\n | 'numeric'\n | 'tel'\n | 'search'\n | 'email'\n | 'url' | undefined" }, "description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.", "fieldName": "inputmode", "inheritedFrom": { "name": "Textarea", "module": "src/components/textarea/textarea.component.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "fieldName": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "value", "description": "Get or set the value of the form control.", "fieldName": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] }, { "kind": "function", "name": "charCounterCallbackDefault", "parameters": [ { "name": "self", "type": { "text": "GdsFormControlElement & { maxlength: number }" } } ], "description": "Default character counter callback function.\nReturns the number of remaining characters and the badge variant based on the current value length and maxlength." } ], "exports": [ { "kind": "js", "name": "GdsTextarea", "declaration": { "name": "GdsTextarea", "module": "src/components/textarea/textarea.component.ts" } }, { "kind": "js", "name": "charCounterCallbackDefault", "declaration": { "name": "charCounterCallbackDefault", "module": "src/components/textarea/textarea.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/textarea/textarea.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Textarea', component: 'gds-textarea', parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-textarea'), }, }", "description": "A textarea enables multi-line text input from users." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Default', render: () => html` `, }" }, { "kind": "variable", "name": "Lead", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Slot: Lead', render: () => html` `, }", "description": "\n\n**@slot lead** - Slot for an icon or other content to be placed at the beginning of the `gds-textarea` field.\n\n```html\n \n \n```" }, { "kind": "variable", "name": "Trail", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Slot: Trail', render: () => html` SEK `, }", "description": "\n**@slot trail** - Slot for an icon or other content to be placed at the end of the textarea field.\n\n```html\n \n USD\n```" }, { "kind": "variable", "name": "Length", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Length', render: () => html` `, }", "description": "The `length` property can be set to a number to limit the number of characters that can be entered into the textarea field.
    A badge will be displayed, updating as the textarea approaches the character limit.\n\n**@property maxLength** - The maximum number of characters that can be entered into the textarea field.\n\n```html\n \n```" }, { "kind": "variable", "name": "Rows", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Rows', render: () => html` Rows:8 Clearable and auto resize Rows:8 Clearable and no resize `, }", "description": "Minimum number of rows to display in the textarea is `4` by default.
    \nYou can specify the number of rows to display in the textarea using the `rows` attribute." }, { "kind": "variable", "name": "Resize", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Resize', render: () => html` Resize: Auto Based on the content Resize: Manual Draging the pull tab to resize Resize: False Will not resize at all `, }", "description": "The `resize` property is set to `auto` by default, allowing the user to resize the textarea.\n\nTo disable the resize functionality, set the `resize` property to `false`.\n\nWhen the `resize` property is set to `auto`, a resize handle will appear at the bottom center of the textarea when the user hovers over it. Dragging this handle will resize the textarea.\n\nThe textarea's size is adjustable based on the `rows` attribute and the content within the textarea." }, { "kind": "variable", "name": "Size", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Size', render: () => html` Size: Small Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Size: Large(default) Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "The `size` property controls the font-size of the text in form control header and footer.\n\nThe `size` property can be set to `small` or `large`.
    \nThe default size is `large`.\n\n```html\n \n```" }, { "kind": "variable", "name": "Clearable", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Clearable', render: () => html` `, }", "description": "When the `clearable` property is set, a clear button is added, allowing users to quickly clear the text." }, { "kind": "variable", "name": "SupportingText", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Supporting Text', render: () => html` `, }", "description": "The `supporting-text` property can be set to a string to provide additional information about the textarea field.\n\n**@property supporting-text** - Additional information about the textarea field.\n\n```html\n \n```" }, { "kind": "variable", "name": "ExtendedSupportingText", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Extended Supporting Text', render: () => html` Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. `, }", "description": "The `extended-supporting-text` slot can be used to provide extended information about the textarea field.
    \nThe slot will show by default when the `show-extended-supporting-text` property is set.
    \nIf not specified, the slot will be hidden and a companion icon will be displayed to indicate that more information is available.\n\n**@slot extended-supporting-text** - Extended information about the textarea field.\n\n```html\n\n Extended supporting text\n\n```\n\n**@property show-extended-supporting-text** - Shows the extended supporting text.\n\n```html\n\n```" }, { "kind": "variable", "name": "Validation", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Validation', render: () => html` { if (el.value === '') return [ { ...el.validity, valid: false, customError: true, }, 'You need to enter a value.', ] else if (el.value.length !== 12 || isNaN(el.value)) return [ { ...el.validity, valid: false, customError: true, }, 'The value must be 12 characters long.', ] }, }} > Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. { if (el.value === '') return [ { ...el.validity, valid: false, customError: true, }, 'Error message.', ] else if (el.value.length !== 12 || isNaN(el.value)) return [ { ...el.validity, valid: false, customError: true, }, 'The value must be a 12 characters long numeric value. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ', ] }, }} clearable > `, }", "description": "Textarea has built-in support for form validation.
    The validation feature is built on top of the browsers native validation features, using `ElementInternals` and `Constraint Validation API`.\n\nValidation is configured by adding a validator to a form element.
    A validator is an object that implements the `GdsValidator` interface:\n\n```html\n {\n if (el.value === '')\n return [\n {\n ...el.validity,\n valid: false,\n customError: true,\n },\n 'Error message.',\n ]\n },\n }}>\n```\n**@property invalid** - Indicates that the textarea field contains an error.\n\n```html\n\n```" }, { "kind": "variable", "name": "StandardAttributes", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Standard Attributes', render: () => html` `, }", "description": "Most standard attributes are supported, and will be forwarded to the internal textarea element." }, { "kind": "variable", "name": "Disabled", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Disabled', render: () => html` `, }", "description": "The `disabled` property can be set to disable the textarea field.\n\n**@property disabled** - Disables the textarea field.\n\n```html\n \n```" }, { "kind": "variable", "name": "CustomCounterBadge", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Custom counter badge', render: () => html` { let badgeType: GdsBadge['variant'] = 'positive' if (inp.value) { switch (inp.value.length % 5) { case 0: badgeType = 'positive' break case 1: badgeType = 'negative' break case 2: badgeType = 'notice' break case 3: badgeType = 'warning' break case 4: badgeType = 'information' break } } return [inp.value!.length, badgeType] as const }} > `, }", "description": "The `charCounterCallback` property can be used to customize the character counter badge.\n\nCheck the [story source](https://github.com/seb-oss/green/blob/main/libs/core/src/components/textarea/textarea.stories.ts) to see the full code for this example, as Storybook strips away property assignments in the code examples." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "Lead", "declaration": { "name": "Lead", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "Trail", "declaration": { "name": "Trail", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "Length", "declaration": { "name": "Length", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "Rows", "declaration": { "name": "Rows", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "Resize", "declaration": { "name": "Resize", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "Size", "declaration": { "name": "Size", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "Clearable", "declaration": { "name": "Clearable", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "SupportingText", "declaration": { "name": "SupportingText", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "ExtendedSupportingText", "declaration": { "name": "ExtendedSupportingText", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "Validation", "declaration": { "name": "Validation", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "StandardAttributes", "declaration": { "name": "StandardAttributes", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "Disabled", "declaration": { "name": "Disabled", "module": "src/components/textarea/textarea.stories.ts" } }, { "kind": "js", "name": "CustomCounterBadge", "declaration": { "name": "CustomCounterBadge", "module": "src/components/textarea/textarea.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/textarea/textarea.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` textarea { height: calc(1lh * var(--_lines)); min-height: calc(1lh * 4); max-height: calc(1lh * 20); overflow: auto; min-width: 20ch; padding-inline-end: calc( var(--gds-sys-space-xs) + var(--padding-inline-end) ); &.resize-manual { resize: vertical; } &.resize-auto { resize: none; } &.resize-false { resize: none; } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/textarea/textarea.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/textarea/textarea.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsTextarea", "declaration": { "name": "GdsTextarea", "module": "src/components/textarea/textarea.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/theme/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/theme/theme" } } ] }, { "kind": "javascript-module", "path": "src/components/theme/theme.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsTheme", "slots": [ { "description": "The content to apply the theme to.", "name": "" } ], "members": [ { "kind": "field", "name": "colorScheme", "type": { "text": "'light' | 'dark' | 'auto'" }, "default": "'light'", "description": "The theme mode. Can be `light`, `dark`, or `auto`.", "attribute": "color-scheme", "reflects": true }, { "kind": "field", "name": "designVersion", "type": { "text": "'2016' | '2023'" }, "default": "'2023'", "description": "The design version to use. Can be `16` or `23`.", "attribute": "design-version", "reflects": true }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Fired when the color scheme changes.", "name": "gds-color-scheme-changed" }, { "description": "Fired when the design version changes.", "name": "gds-design-version-changed" }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "color-scheme", "type": { "text": "'light' | 'dark' | 'auto'" }, "default": "'light'", "description": "The theme mode. Can be `light`, `dark`, or `auto`.", "fieldName": "colorScheme" }, { "name": "design-version", "type": { "text": "'2016' | '2023'" }, "default": "'2023'", "description": "The design version to use. Can be `16` or `23`.", "fieldName": "designVersion" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-theme", "customElement": true } ], "exports": [ { "kind": "js", "name": "GdsTheme", "declaration": { "name": "GdsTheme", "module": "src/components/theme/theme.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/theme/theme.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Theme', component: 'gds-theme', tags: ['autodocs'], }", "description": "`gds-theme` is a utility component that can be used to control which CSS variables and styles\nare applied to its children. It can be used to control light and dark mode, as well as which\ndesign version the children should use (2016 or 2023)\n\nFor the 2016 styles to work, [Transitioanl Styles](http://localhost:4400/?path=/docs/concepts-transitional-styles--docs)\nmust be imported and and registered for the used components." }, { "kind": "variable", "name": "Theme", "type": { "text": "Story" }, "default": "{ ...DefaultParams, parameters: { ...DefaultParams.parameters, globals: { disableTheme: true, }, }, render: () => html` Auto mode button in a card (2023) Light mode button in a card Dark mode button in a card Auto mode button in a card (2016) Light mode button in a card (2016) Dark mode button in a card (2016) `, }", "description": "Inspect this example and try changing the properties of `gds-theme`." } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/theme/theme.stories.ts" } }, { "kind": "js", "name": "Theme", "declaration": { "name": "Theme", "module": "src/components/theme/theme.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/theme/theme.styles.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/theme/theme.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/theme/theme.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/theme/theme.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/theme/theme.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsTheme", "declaration": { "name": "GdsTheme", "module": "src/components/theme/theme.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/video/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/video/video" } } ] }, { "kind": "javascript-module", "path": "src/components/video/video.component.ts", "declarations": [ { "kind": "class", "description": "`gds-video` is a custom video element that provides configurable .mp4 video playback that can be used as background or hero video without controls.\nThe video can be customized with different properties like ratio, position, inset, width, height, opacity, fit, and radius.", "name": "GdsVideo", "members": [ { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Controls the aspect ratio of the image.\nSupports all common aspect ratios like 16/9, 4/3, 1/1, etc.\n\nYou can apply the aspect ratio like this:\n\n```html\n\n```\n\nThe above example will apply the aspect ratio of 16/9.\n\nYou can also apply different aspect ratios for different screen sizes like this:\n\n```html\n\n```\n\n The above example will apply the aspect ratio of 16/9 for large screens, 4/3 for medium screens, and 1/1 for small screens." }, { "kind": "field", "name": "'object-position'", "type": { "text": "string | undefined" }, "description": "Controls the `object-position` of the video.\nSupports all common CSS values." }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Controls the opacity property of the image.\n\nYou can apply opacity like this:\n\n```html\n\n```\n\nThe above example will apply the opacity style of 0.2.\nThis is useful when you want to apply a transparent effect to the image when having a darkened background to increase the readability of the text.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'object-fit'", "type": { "text": "string | undefined" }, "description": "Controls the object-fit property of the image.\n\nYou can apply fit like this:\n\n```html\n\n```\n\n The above example will apply the object-fit style of cover." }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Controls the pointer-events property of the video.\nSupports all valid CSS pointer-events values." }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Controls the border-radius property of the video.\nSupports all the size tokens from the design system.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "src", "type": { "text": "string | undefined" }, "attribute": "src" }, { "kind": "field", "name": "poster", "type": { "text": "string | undefined" }, "attribute": "poster" }, { "kind": "field", "name": "muted", "type": { "text": "boolean | undefined" }, "attribute": "muted" }, { "kind": "field", "name": "playsinline", "type": { "text": "boolean | undefined" }, "attribute": "playsinline" }, { "kind": "field", "name": "autoplay", "type": { "text": "boolean | undefined" }, "attribute": "autoplay" }, { "kind": "field", "name": "loop", "type": { "text": "boolean | undefined" }, "attribute": "loop" }, { "kind": "field", "name": "videoElement", "type": { "text": "HTMLVideoElement" } }, { "kind": "method", "name": "applyVideoSettings" }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "src", "type": { "text": "string | undefined" }, "fieldName": "src" }, { "name": "poster", "type": { "text": "string | undefined" }, "fieldName": "poster" }, { "name": "muted", "type": { "text": "boolean | undefined" }, "fieldName": "muted" }, { "name": "playsinline", "type": { "text": "boolean | undefined" }, "fieldName": "playsinline" }, { "name": "autoplay", "type": { "text": "boolean | undefined" }, "fieldName": "autoplay" }, { "name": "loop", "type": { "text": "boolean | undefined" }, "fieldName": "loop" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeYProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withPositioningProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-video", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsVideo", "declaration": { "name": "GdsVideo", "module": "src/components/video/video.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/video/video.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Video', component: 'gds-video', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-video'), }, }", "description": "The `gds-video`" }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/video/video.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/video/video.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/video/video.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` :host { display: block; margin: 0; padding: 0; box-sizing: border-box; font-size: 0; width: 100%; height: auto; overflow: hidden; } video { display: flex; width: 100%; height: 100%; } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/video/video.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/video/video.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsVideo", "declaration": { "name": "GdsVideo", "module": "src/components/video/video.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/controllers/dynamic-styles-controller.ts", "declarations": [ { "kind": "class", "description": "", "name": "DynamicStylesController", "members": [ { "kind": "field", "name": "host", "type": { "text": "GdsElement" }, "default": "host" }, { "kind": "method", "name": "hostConnected" }, { "kind": "method", "name": "has", "parameters": [ { "name": "key", "type": { "text": "string" }, "description": "The style key to check." } ], "description": "Checks if the controller has a particular key." }, { "kind": "method", "name": "inject", "parameters": [ { "name": "key", "type": { "text": "string" }, "description": "A unique key to identify the styles." }, { "name": "cssResult", "type": { "text": "CSSResult" }, "description": "The CSSResult to inject." } ], "description": "Injects CSS into the host element's shadow root. The key is used to\nidentify the styles and can be used to update the styles later. If\nyou need to clear style for a particular key, you can call `inject`\nwith an empty string as the `styles` parameter." }, { "kind": "method", "name": "clear", "parameters": [ { "name": "key", "type": { "text": "string" }, "description": "The key of the styles to clear." } ], "description": "Clears the styles for a particular key." }, { "kind": "method", "name": "clearAll", "description": "Clears all styles of the component, including any initial styles." }, { "kind": "method", "name": "clearInitial", "description": "Clears the initial styles of the component, but keeps any injected styles." }, { "kind": "method", "name": "restoreInitial", "description": "Restores the initial styles of the component, and keeps any injected styles." } ] }, { "kind": "function", "name": "supportsConstructedStylesheets" } ], "exports": [ { "kind": "js", "name": "DynamicStylesController", "declaration": { "name": "DynamicStylesController", "module": "src/utils/controllers/dynamic-styles-controller.ts" } }, { "kind": "js", "name": "supportsConstructedStylesheets", "declaration": { "name": "supportsConstructedStylesheets", "module": "src/utils/controllers/dynamic-styles-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/controllers/listbox-kb-nav-controller.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/decorators/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/utils/decorators/watch" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/utils/decorators/observe-light-dom" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/utils/decorators/watch-media-query" } } ] }, { "kind": "javascript-module", "path": "src/utils/decorators/observe-light-dom.ts", "declarations": [ { "kind": "function", "name": "observeLightDOM", "parameters": [ { "name": "observerConfig", "default": "{\n attributes: true,\n childList: true,\n subtree: false,\n characterData: true,\n }", "type": { "text": "MutationObserverInit" } } ], "description": "Runs when the light DOM children of the component changes." } ], "exports": [ { "kind": "js", "name": "observeLightDOM", "declaration": { "name": "observeLightDOM", "module": "src/utils/decorators/observe-light-dom.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/decorators/resize-observer.ts", "declarations": [ { "kind": "function", "name": "resizeObserver", "description": "Runs when the size of the component changes.\n\nUsage:\n```javascript\n\\@resizeObserver()\nhandleResize() {\n // Do some layout calculation or something\n}\n```" } ], "exports": [ { "kind": "js", "name": "resizeObserver", "declaration": { "name": "resizeObserver", "module": "src/utils/decorators/resize-observer.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/decorators/style-expression-property.ts", "declarations": [ { "kind": "function", "name": "styleExpressionProperty", "parameters": [ { "name": "options", "optional": true, "type": { "text": "StyleExpressionPropertyOptions" }, "description": "Options for the decorator." } ], "description": "A decorator that can be used to create a Style Expression Property." } ], "exports": [ { "kind": "js", "name": "styleExpressionProperty", "declaration": { "name": "styleExpressionProperty", "module": "src/utils/decorators/style-expression-property.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/decorators/watch-media-query.ts", "declarations": [ { "kind": "variable", "name": "standardBreakpoints", "type": { "text": "object" }, "default": "{ sm: '(min-width: 576px)', md: '(min-width: 768px)', lg: '(min-width: 1024px)', xl: '(min-width: 1280px)', }", "description": "Media queries expressing standard breakpoints.\nTODO: These should probably be imported from somehere, so that they are always in sync with CSS." }, { "kind": "function", "name": "watchMediaQuery", "parameters": [ { "name": "q", "type": { "text": "string" }, "description": "The media query to watch.\n\nUsage:\n```javascript\n\\@watchMediaQuery('(max-width: 576px)')\nhandleMobileLayout(matches) {\nif (matches) {\n// Do something when the media query matches\n} else\n// Do something when the media query no longer matches\n}\n}\n```" } ], "description": "Runs when the match state of the specified media query changes." } ], "exports": [ { "kind": "js", "name": "standardBreakpoints", "declaration": { "name": "standardBreakpoints", "module": "src/utils/decorators/watch-media-query.ts" } }, { "kind": "js", "name": "watchMediaQuery", "declaration": { "name": "watchMediaQuery", "module": "src/utils/decorators/watch-media-query.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/decorators/watch.ts", "declarations": [ { "kind": "function", "name": "watch", "parameters": [ { "name": "propertyName", "type": { "text": "string | string[]" } }, { "name": "options", "optional": true, "type": { "text": "WatchOptions" } } ], "description": "Runs when observed properties change, e.g." } ], "exports": [ { "kind": "js", "name": "watch", "declaration": { "name": "watch", "module": "src/utils/decorators/watch.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/directives/forward-attributes.ts", "declarations": [ { "kind": "variable", "name": "forwardAttributes" } ], "exports": [ { "kind": "js", "name": "forwardAttributes", "declaration": { "name": "forwardAttributes", "module": "src/utils/directives/forward-attributes.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/directives/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/utils/directives/forward-attributes" } } ] }, { "kind": "javascript-module", "path": "src/utils/helpers/attribute-converters.ts", "declarations": [ { "kind": "variable", "name": "dateConverter", "type": { "text": "ComplexAttributeConverter" }, "default": "{ fromAttribute(value: string) { return new Date(value) }, toAttribute(value: Date) { return value.toISOString() }, }", "description": "Converts between an ISO date string and a Date object." }, { "kind": "variable", "name": "dateArrayConverter", "type": { "text": "ComplexAttributeConverter" }, "default": "{ fromAttribute(value: string) { return value.split(',').map((d) => new Date(d.trim())) }, toAttribute(value: Date[]) { return JSON.stringify(value.map((d) => d.toISOString())) }, }", "description": "Converts between a comma-separated list of ISO date strings and an array of Date objects." }, { "kind": "variable", "name": "stringArrayConverter", "type": { "text": "ComplexAttributeConverter" }, "default": "{ fromAttribute(value: string) { return value.split(',') }, toAttribute(value: string[]) { return Array.isArray(value) ? value.join(',') : value }, }", "description": "Converts between a comma-separated list of strings and an array of strings." } ], "exports": [ { "kind": "js", "name": "dateConverter", "declaration": { "name": "dateConverter", "module": "src/utils/helpers/attribute-converters.ts" } }, { "kind": "js", "name": "dateArrayConverter", "declaration": { "name": "dateArrayConverter", "module": "src/utils/helpers/attribute-converters.ts" } }, { "kind": "js", "name": "stringArrayConverter", "declaration": { "name": "stringArrayConverter", "module": "src/utils/helpers/attribute-converters.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/helpers/casing.ts", "declarations": [ { "kind": "function", "name": "kebabToCamelCase", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "str", "type": { "text": "string" } } ], "description": "Converts a kebab-case string to camelCase" }, { "kind": "function", "name": "toPascalCase", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "str", "type": { "text": "string" } } ], "description": "Converts a kebab-case or camelCase string to PascalCase" }, { "kind": "function", "name": "camelToKebabCase", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "str", "type": { "text": "string" } } ], "description": "Converts a camelCase string to kebab-case" }, { "kind": "function", "name": "capitalize", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "str", "type": { "text": "string" } } ], "description": "Capitalizes the first letter of a string" } ], "exports": [ { "kind": "js", "name": "kebabToCamelCase", "declaration": { "name": "kebabToCamelCase", "module": "src/utils/helpers/casing.ts" } }, { "kind": "js", "name": "toPascalCase", "declaration": { "name": "toPascalCase", "module": "src/utils/helpers/casing.ts" } }, { "kind": "js", "name": "camelToKebabCase", "declaration": { "name": "camelToKebabCase", "module": "src/utils/helpers/casing.ts" } }, { "kind": "js", "name": "capitalize", "declaration": { "name": "capitalize", "module": "src/utils/helpers/casing.ts" } }, { "kind": "js", "name": "default", "declaration": { "module": "src/utils/helpers/casing.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/helpers/component-meta.ts", "declarations": [ { "kind": "class", "description": "Parses the Custom Elements Manifest and extracts component data", "name": "CemParser", "members": [ { "kind": "method", "name": "loadManifest", "static": true, "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "cemPath", "default": "'../../../custom-elements.json'" } ], "description": "Loads and parses the CEM file" }, { "kind": "method", "name": "getComponentModules", "static": true, "return": { "type": { "text": "JavaScriptModule[]" } }, "parameters": [ { "name": "manifest", "type": { "text": "Package" } } ], "description": "Extracts modules that contain web components" }, { "kind": "method", "name": "extractComponentData", "static": true, "return": { "type": { "text": "ComponentData" } }, "parameters": [ { "name": "mod", "type": { "text": "JavaScriptModule" } }, { "name": "declaration", "type": { "text": "CustomElementDeclaration" } } ], "description": "Extracts component data from a JavaScriptModule declaration" }, { "kind": "method", "name": "findReExportedPrimitives", "static": true, "return": { "type": { "text": "ReExportedPrimitive[]" } }, "parameters": [ { "name": "manifest", "type": { "text": "Package" } } ], "description": "Finds primitives that are re-exported by component modules.\n\nPrimitives (like GdsOption, GdsMenuHeading) are internal implementation details\nbut some are re-exported by specific components for public use. For example:\n- GdsOption is re-exported by GdsDropdown\n- GdsMenuHeading is re-exported by GdsContextMenu\n\nThis method identifies these re-exports and returns the component file path\n(not the primitive path) so imports point to the re-exporting component.\n\nDesign choices:\n- Only considers *.component.ts files, not index.ts files, to ensure imports\n point to the actual component file (e.g., dropdown.component.js not index.js)\n because index.ts paths are not tree-shakable\n- First occurrence wins when a primitive is re-exported by multiple components" }, { "kind": "method", "name": "parseAllComponents", "static": true, "return": { "type": { "text": "Promise<{\n components: ComponentData[]\n reExportedPrimitives: ReExportedPrimitive[]\n }>" } }, "parameters": [ { "name": "manifestPath", "optional": true, "type": { "text": "string" } } ], "description": "Parses all components from the manifest" }, { "kind": "method", "name": "parseComponent", "static": true, "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "tagName", "type": { "text": "string" } }, { "name": "manifestPath", "optional": true, "type": { "text": "string" } } ], "description": "Parses a single component by tag name" } ] } ], "exports": [ { "kind": "js", "name": "ComponentData", "declaration": { "name": "ComponentData", "module": "src/utils/helpers/component-meta.ts" } }, { "kind": "js", "name": "CemParser", "declaration": { "name": "CemParser", "module": "src/utils/helpers/component-meta.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/helpers/component-meta.types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/helpers/custom-element-scoping.ts", "declarations": [ { "kind": "variable", "name": "VER_SUFFIX", "type": { "text": "string" }, "default": "'-gdsvsuffix'" }, { "kind": "class", "description": "", "name": "ScopedElementRegistry", "members": [ { "kind": "field", "name": "instance", "static": true, "readonly": true } ] }, { "kind": "function", "name": "gdsCustomElement", "parameters": [ { "name": "tagName", "type": { "text": "string" }, "description": "The tag name of the custom element to define." }, { "name": "options", "optional": true, "type": { "text": "GdsCustomElementOptions" } } ], "description": "Class decorator factory that defines the decorated class as a custom element, and registers\nit with the custom element registry under a versioned name.\n\n```js" }, { "kind": "variable", "name": "nameToRegister" }, { "kind": "function", "name": "htmlTemplateTagFactory", "parameters": [ { "name": "extendedTag", "type": { "text": "(strings: TemplateStringsArray, ...values: any[]) => any" } } ], "description": "Template tag factory that creates a new template tag, which rewrites all custom element names from the\nlookup table to include the version suffix, and then passes the template on to the provided template tag." }, { "kind": "variable", "name": "html", "description": "Template tag that rewrites all custom element names from the lookup table to include the\nversion suffix, before passing the template on to the Lit `html` tag." }, { "kind": "function", "name": "getScopedTagName", "parameters": [ { "name": "tagName", "type": { "text": "string" }, "description": "The tag name to scope" }, { "name": "alwaysAddSuffix", "default": "false" } ], "description": "Returns the correctly scoped tag name for the given tag." }, { "kind": "function", "name": "getUnscopedTagName", "parameters": [ { "name": "tagName", "type": { "text": "string" }, "description": "The scoped tag name to unscope" } ], "description": "Returns the unscoped tag name for the given scoped tag." } ], "exports": [ { "kind": "js", "name": "VER_SUFFIX", "declaration": { "name": "VER_SUFFIX", "module": "src/utils/helpers/custom-element-scoping.ts" } }, { "kind": "js", "name": "ScopedElementRegistry", "declaration": { "name": "ScopedElementRegistry", "module": "src/utils/helpers/custom-element-scoping.ts" } }, { "kind": "js", "name": "gdsCustomElement", "declaration": { "name": "gdsCustomElement", "module": "src/utils/helpers/custom-element-scoping.ts" } }, { "kind": "custom-element-definition", "name": "nameToRegister", "declaration": { "name": "Component", "module": "src/utils/helpers/custom-element-scoping.ts" } }, { "kind": "js", "name": "htmlTemplateTagFactory", "declaration": { "name": "htmlTemplateTagFactory", "module": "src/utils/helpers/custom-element-scoping.ts" } }, { "kind": "js", "name": "html", "declaration": { "name": "html", "module": "src/utils/helpers/custom-element-scoping.ts" } }, { "kind": "js", "name": "getScopedTagName", "declaration": { "name": "getScopedTagName", "module": "src/utils/helpers/custom-element-scoping.ts" } }, { "kind": "js", "name": "getUnscopedTagName", "declaration": { "name": "getUnscopedTagName", "module": "src/utils/helpers/custom-element-scoping.ts" } }, { "kind": "js", "name": "default", "declaration": { "module": "src/utils/helpers/custom-element-scoping.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/helpers/id.ts", "declarations": [ { "kind": "function", "name": "randomId", "return": { "type": { "text": "string" } } } ], "exports": [ { "kind": "js", "name": "randomId", "declaration": { "name": "randomId", "module": "src/utils/helpers/id.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/helpers/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/utils/helpers/id" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/utils/helpers/style-expression-helpers" } } ] }, { "kind": "javascript-module", "path": "src/utils/helpers/platform.ts", "declarations": [ { "kind": "variable", "name": "isServer", "description": "Check if the code is running on the server" }, { "kind": "variable", "name": "isIOS", "description": "Simple UA check to determine if the platform is iOS" } ], "exports": [ { "kind": "js", "name": "isServer", "declaration": { "name": "isServer", "module": "src/utils/helpers/platform.ts" } }, { "kind": "js", "name": "isIOS", "declaration": { "name": "isIOS", "module": "src/utils/helpers/platform.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/helpers/strip-white-space.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/helpers/style-expression-helpers.ts", "declarations": [ { "kind": "function", "name": "parseColorValue", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "value", "type": { "text": "string" }, "description": "The color token name" }, { "name": "context", "type": { "text": "string" }, "description": "The context, such as content, background, border, etc." }, { "name": "level", "type": { "text": "GdsColorLevel" }, "description": "The level of the color. Can be 1, 2 or 3" } ], "description": "Parse color token value to a css var expression. If slash is present,\nthe value after the slash vill be used for transparency." }, { "kind": "function", "name": "forColorTokens", "return": { "type": { "text": "StyleExpressionPropertyOptions" } }, "parameters": [ { "name": "context", "type": { "text": "string" }, "description": "The context, such as content, background, border, etc." } ], "description": "Create options for style expression properties that expect color tokens." }, { "kind": "variable", "name": "forSpaceTokens", "type": { "text": "StyleExpressionPropertyOptions" }, "default": "{ valueTemplate: (value: string) => `var(--gds-sys-space-${value}, 0)`, }", "description": "Create options for style expression properties that expect space tokens." }, { "kind": "variable", "name": "forRadiusTokens", "type": { "text": "StyleExpressionPropertyOptions" }, "default": "{ valueTemplate: (value: string) => `var(--gds-sys-radius-${value}, 0)`, }", "description": "Create options for style expression properties that expect radius tokens." }, { "kind": "variable", "name": "forSpaceTokensAndCustomValues", "type": { "text": "StyleExpressionPropertyOptions" }, "default": "{ valueTemplate: (value: string) => `var(--gds-sys-space-${sanitizeVariableName(value)}, ${value})`, }", "description": "Create options for style expression properties that expect space tokens." }, { "kind": "variable", "name": "forSpaceTokensSupportingNegative", "type": { "text": "StyleExpressionPropertyOptions" }, "default": "{ valueTemplate: (v) => { const sign = v.startsWith('-') ? 'neg' : 'pos' const val = sign == 'pos' ? `var(--gds-sys-space-${v})` : `calc(var(--gds-sys-space-${v.substring(1)}) * -1)` return v === 'auto' ? 'auto' : val }, styleTemplate: (prop, values) => { const transformValue = (v: string) => (v === 'auto' ? 'auto' : `${v}`) const top = transformValue(values[0]) const right = values.length > 1 ? transformValue(values[1]) : top const bottom = values.length > 2 ? transformValue(values[2]) : top const left = values.length > 3 ? transformValue(values[3]) : right return `${prop}: ${top} ${right} ${bottom} ${left};` }, }", "description": "Create options for style expression properties that expect space tokens.\nThis version supports negative values." } ], "exports": [ { "kind": "js", "name": "parseColorValue", "declaration": { "name": "parseColorValue", "module": "src/utils/helpers/style-expression-helpers.ts" } }, { "kind": "js", "name": "forColorTokens", "declaration": { "name": "forColorTokens", "module": "src/utils/helpers/style-expression-helpers.ts" } }, { "kind": "js", "name": "forSpaceTokens", "declaration": { "name": "forSpaceTokens", "module": "src/utils/helpers/style-expression-helpers.ts" } }, { "kind": "js", "name": "forRadiusTokens", "declaration": { "name": "forRadiusTokens", "module": "src/utils/helpers/style-expression-helpers.ts" } }, { "kind": "js", "name": "forSpaceTokensAndCustomValues", "declaration": { "name": "forSpaceTokensAndCustomValues", "module": "src/utils/helpers/style-expression-helpers.ts" } }, { "kind": "js", "name": "forSpaceTokensSupportingNegative", "declaration": { "name": "forSpaceTokensSupportingNegative", "module": "src/utils/helpers/style-expression-helpers.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/helpers/style-expression-parser-tester.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/utils/helpers/style-expression-parser.ts", "declarations": [ { "kind": "function", "name": "tokenize", "return": { "type": { "text": "" } }, "parameters": [ { "name": "source", "default": "''", "description": "The source string to tokenize" } ], "description": "Takes a string and returns an array of tokens. Each token is a string or control character." }, { "kind": "function", "name": "parse", "return": { "type": { "text": "" } }, "parameters": [ { "name": "tokens", "type": { "text": "Tokens" }, "description": "An array of tokens" } ], "description": "Takes an array of tokens and returns a basic AST structure." }, { "kind": "function", "name": "toCss", "parameters": [ { "name": "selector", "type": { "text": "string" } }, { "name": "property", "type": { "text": "string" } }, { "name": "tree", "type": { "text": "BreakpointTree" } }, { "name": "valueTemplate", "default": "(v) => v", "type": { "text": "(value: string) => string" } }, { "name": "styleTemplate", "default": "(p, vs) =>\n `${p}: ${vs.join(' ')};`", "type": { "text": "(property: string, values: string[]) => string" } } ], "description": "Takes a selector, a rule, and a tree of breakpoints and returns a CSS string." } ], "exports": [ { "kind": "js", "name": "tokenize", "declaration": { "name": "tokenize", "module": "src/utils/helpers/style-expression-parser.ts" } }, { "kind": "js", "name": "parse", "declaration": { "name": "parse", "module": "src/utils/helpers/style-expression-parser.ts" } }, { "kind": "js", "name": "toCss", "declaration": { "name": "toCss", "module": "src/utils/helpers/style-expression-parser.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/helpers/unwrap-slots.ts", "declarations": [ { "kind": "function", "name": "unwrap", "parameters": [ { "name": "slotRef", "type": { "text": "HTMLSlotElement" } } ], "description": "Unwraps nested slots and returns the first slot that has actual assigned elements as children." } ], "exports": [ { "kind": "js", "name": "unwrap", "declaration": { "name": "unwrap", "module": "src/utils/helpers/unwrap-slots.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/localization/localization.ts", "declarations": [ { "kind": "function", "name": "gdsInitLocalization", "parameters": [ { "name": "{ extraLocales, extraTemplates }", "default": "{\n extraLocales: [],\n extraTemplates: new Map(),\n }", "type": { "text": "LocalizationConfig" } }, { "description": "Extra locales to add to the list of target locales", "name": "extraLocales" }, { "description": "Extra templates to add to the list of localized templates", "name": "extraTemplates" } ], "description": "Initializes localization for Green Core. This is a wrapper around Lit's `configureLocalization`,\nwhich adds the ability to add extra locales and templates." } ], "exports": [ { "kind": "js", "name": "targetLocales", "declaration": { "name": "targetLocales", "module": "src/utils/localization/localization.ts" } }, { "kind": "js", "name": "gdsInitLocalization", "declaration": { "name": "gdsInitLocalization", "module": "src/utils/localization/localization.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/mixins/declarative-layout-mixins.ts", "declarations": [ { "kind": "mixin", "description": "Mixin that adds horizontal and inline sizing properties to a component.", "name": "withSizeXProps", "members": [ { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ] }, { "kind": "mixin", "description": "Mixin that adds vertical and block sizing properties to a component.", "name": "withSizeYProps", "members": [ { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ] }, { "kind": "mixin", "description": "Mixin that adds margin properties to a component.", "name": "withMarginProps", "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ] }, { "kind": "mixin", "description": "Mixin that adds padding properties to a component.", "name": "withPaddingProps", "members": [ { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ] }, { "kind": "mixin", "description": "Mixin that adds layout child properties to a component.\n\n'Layout child' properties are properties that are applies to the children of layout containers such as `gds-div`, `gds-flex` and `gds-grid`.", "name": "withLayoutChildProps", "members": [ { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ] }, { "kind": "mixin", "description": "Mixin that adds positioning properties to a component.", "name": "withPositioningProps", "members": [ { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties" }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ] } ], "exports": [ { "kind": "js", "name": "withSizeXProps", "declaration": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "js", "name": "withSizeYProps", "declaration": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "js", "name": "withMarginProps", "declaration": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "js", "name": "withPaddingProps", "declaration": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "js", "name": "withLayoutChildProps", "declaration": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "js", "name": "withPositioningProps", "declaration": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/mixins/focusable.ts", "declarations": [ { "kind": "mixin", "description": "This mixin handles focusing of elements, and adds the `gds-focus` and `gds-blur` events.", "name": "Focusable", "members": [ { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions | undefined" } } ] } ], "events": [ { "name": "gds-blur", "type": { "text": "FocusEvent" } }, { "name": "gds-focus", "type": { "text": "FocusEvent" } } ], "parameters": [ { "name": "superClass", "type": { "text": "T" } } ] } ], "exports": [ { "kind": "js", "name": "Focusable", "declaration": { "name": "Focusable", "module": "src/utils/mixins/focusable.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/mixins/mixin-builder.ts", "declarations": [ { "kind": "function", "name": "mix", "return": { "type": { "text": "MixinBuilder" } }, "parameters": [ { "name": "BaseClass", "type": { "text": "TBase" } } ] } ], "exports": [ { "kind": "js", "name": "mix", "declaration": { "name": "mix", "module": "src/utils/mixins/mixin-builder.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/mixins/props-image.ts", "declarations": [ { "kind": "mixin", "description": "Mixin that adds image-related properties to a component.\nUse this for any component that needs to display images with responsive\nand accessibility support.", "name": "withImageProps", "members": [ { "kind": "field", "name": "src", "type": { "text": "string | undefined" }, "description": "The URL of the image", "attribute": "src" }, { "kind": "field", "name": "srcset", "type": { "text": "string | undefined" }, "description": "The srcset attribute for responsive images\nFormat: \"image.jpg 1x, image-2x.jpg 2x\" or \"image-320.jpg 320w, image-640.jpg 640w\"", "attribute": "srcset" }, { "kind": "field", "name": "sizes", "type": { "text": "string | undefined" }, "description": "The sizes attribute for responsive images\nFormat: \"(max-width: 320px) 280px, (max-width: 640px) 580px, 800px\"", "attribute": "sizes" }, { "kind": "field", "name": "alt", "type": { "text": "string | undefined" }, "description": "Alternative text description of the image\nRequired for accessibility. Should be empty string if image is decorative.", "attribute": "alt" }, { "kind": "field", "name": "loading", "type": { "text": "'lazy' | 'eager' | undefined" }, "default": "'lazy'", "description": "Loading strategy for the image", "attribute": "loading" }, { "kind": "field", "name": "decoding", "type": { "text": "'auto' | 'sync' | 'async' | undefined" }, "default": "'auto'", "description": "Decoding strategy for the image", "attribute": "decoding" } ], "attributes": [ { "name": "src", "type": { "text": "string | undefined" }, "description": "The URL of the image", "fieldName": "src" }, { "name": "srcset", "type": { "text": "string | undefined" }, "description": "The srcset attribute for responsive images\nFormat: \"image.jpg 1x, image-2x.jpg 2x\" or \"image-320.jpg 320w, image-640.jpg 640w\"", "fieldName": "srcset" }, { "name": "sizes", "type": { "text": "string | undefined" }, "description": "The sizes attribute for responsive images\nFormat: \"(max-width: 320px) 280px, (max-width: 640px) 580px, 800px\"", "fieldName": "sizes" }, { "name": "alt", "type": { "text": "string | undefined" }, "description": "Alternative text description of the image\nRequired for accessibility. Should be empty string if image is decorative.", "fieldName": "alt" }, { "name": "loading", "type": { "text": "'lazy' | 'eager' | undefined" }, "default": "'lazy'", "description": "Loading strategy for the image", "fieldName": "loading" }, { "name": "decoding", "type": { "text": "'auto' | 'sync' | 'async' | undefined" }, "default": "'auto'", "description": "Decoding strategy for the image", "fieldName": "decoding" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ] } ], "exports": [ { "kind": "js", "name": "withImageProps", "declaration": { "name": "withImageProps", "module": "src/utils/mixins/props-image.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/mixins/props-link.ts", "declarations": [ { "kind": "mixin", "description": "Mixin that adds link-related properties to a component.\nProvides standard anchor/link functionality with built-in security features.", "name": "withLinkProps", "members": [ { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "description": "URL that the link points to\nCan be absolute, relative, or fragment identifier", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Specifies where to open the linked document", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "description": "Specifies the relationship between the current document and the linked document\nAutomatically adds security-related values when target=\"_blank\"", "attribute": "rel" }, { "kind": "field", "name": "#rel", "privacy": "private", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "download", "type": { "text": "string | boolean | undefined" }, "description": "When present, indicates that the linked resource should be downloaded", "attribute": "download" }, { "kind": "field", "name": "ping", "type": { "text": "string | undefined" }, "description": "Specifies a space-separated list of URLs to which, when the link is followed,\nPOST requests with the body ping will be sent by the browser.", "attribute": "ping" } ], "attributes": [ { "name": "href", "type": { "text": "string | undefined" }, "description": "URL that the link points to\nCan be absolute, relative, or fragment identifier", "fieldName": "href" }, { "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Specifies where to open the linked document", "fieldName": "target" }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "Specifies the relationship between the current document and the linked document\nAutomatically adds security-related values when target=\"_blank\"", "fieldName": "rel" }, { "name": "download", "type": { "text": "string | boolean | undefined" }, "description": "When present, indicates that the linked resource should be downloaded", "fieldName": "download" }, { "name": "ping", "type": { "text": "string | undefined" }, "description": "Specifies a space-separated list of URLs to which, when the link is followed,\nPOST requests with the body ping will be sent by the browser.", "fieldName": "ping" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ] } ], "exports": [ { "kind": "js", "name": "withLinkProps", "declaration": { "name": "withLinkProps", "module": "src/utils/mixins/props-link.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/testing/index.ts", "declarations": [ { "kind": "function", "name": "fixture", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "template", "type": { "text": "TemplateResult" } } ], "description": "Renders a lit template into a container and returns the first element child.\nReplacement for" }, { "kind": "function", "name": "aTimeout", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "ms", "type": { "text": "number" } } ], "description": "Wait for a specified number of milliseconds.\nReplacement for" }, { "kind": "function", "name": "waitUntil", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "condition", "type": { "text": "() => boolean | Promise" } }, { "name": "message", "optional": true, "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "{ interval?: number; timeout?: number }" } } ], "description": "Wait until a condition becomes true or timeout.\nReplacement for" }, { "kind": "function", "name": "clickOnElement", "parameters": [ { "name": "el", "type": { "text": "Element" } }, { "name": "_position", "default": "'center'", "type": { "text": "'top' | 'right' | 'bottom' | 'left' | 'center'" } }, { "name": "_offsetX", "default": "0" }, { "name": "_offsetY", "default": "0" } ], "description": "A testing utility that clicks on an element." }, { "kind": "variable", "name": "timeout", "default": "new Promise((_, reject) => { timeoutId = setTimeout(() => { reject(new Error(`click timed out after ${ms}ms`)) }, ms) })" }, { "kind": "function", "name": "moveMouseOnElement", "parameters": [ { "name": "el", "type": { "text": "Element" } }, { "name": "_position", "default": "'center'", "type": { "text": "'top' | 'right' | 'bottom' | 'left' | 'center'" } }, { "name": "_offsetX", "default": "0" }, { "name": "_offsetY", "default": "0" } ], "description": "A testing utility that moves the mouse onto an element." }, { "kind": "function", "name": "dragElement", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "source", "type": { "text": "Element" } }, { "name": "deltaX", "default": "0" }, { "name": "deltaY", "default": "0" } ], "description": "A testing utility that drags an element with the mouse." }, { "kind": "function", "name": "isWebKit" }, { "kind": "function", "name": "tabNext", "parameters": [ { "name": "options", "optional": true, "type": { "text": "{ shift?: boolean }" } } ], "description": "WebKit-aware Tab helper.\nOn WebKit, use Alt+Tab to move focus" }, { "kind": "function", "name": "isChromium" }, { "kind": "function", "name": "isFirefox" }, { "kind": "function", "name": "onlyDate", "parameters": [ { "name": "date", "type": { "text": "Date | undefined" } } ] }, { "kind": "function", "name": "timeout", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "ms", "type": { "text": "number" } } ], "description": "A helper to wait for a specific amount of time" }, { "kind": "function", "name": "conditionToBeTrue", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "condition", "type": { "text": "() => boolean" } }, { "name": "timeoutMs", "default": "1000" } ], "description": "A helper to wait for a condition to become true" }, { "kind": "function", "name": "setViewportSize", "parameters": [ { "name": "width", "type": { "text": "number" } }, { "name": "height", "type": { "text": "number" } } ] } ], "exports": [ { "kind": "js", "name": "html", "declaration": { "name": "html", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "fixture", "declaration": { "name": "fixture", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "aTimeout", "declaration": { "name": "aTimeout", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "waitUntil", "declaration": { "name": "waitUntil", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "clickOnElement", "declaration": { "name": "clickOnElement", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "moveMouseOnElement", "declaration": { "name": "moveMouseOnElement", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "dragElement", "declaration": { "name": "dragElement", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "isWebKit", "declaration": { "name": "isWebKit", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "tabNext", "declaration": { "name": "tabNext", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "isChromium", "declaration": { "name": "isChromium", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "isFirefox", "declaration": { "name": "isFirefox", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "onlyDate", "declaration": { "name": "onlyDate", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "timeout", "declaration": { "name": "timeout", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "conditionToBeTrue", "declaration": { "name": "conditionToBeTrue", "module": "src/utils/testing/index.ts" } }, { "kind": "js", "name": "setViewportSize", "declaration": { "name": "setViewportSize", "module": "src/utils/testing/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/transitional-styles/transitional-styles.ts", "declarations": [ { "kind": "function", "name": "registerTransitionalStyles", "description": "Registers transitional styles for all components.\n\n**Note:** If you are only using a few components, consider registering those\nseparately instead. That way, any unused styles can get tree shaken away." }, { "kind": "class", "description": "", "name": "TransitionalStyles", "members": [ { "kind": "field", "name": "instance", "static": true, "readonly": true }, { "kind": "method", "name": "apply", "parameters": [ { "name": "element", "type": { "text": "GdsElement" } }, { "name": "styleKey", "type": { "text": "string" } } ] }, { "kind": "method", "name": "applyToElement", "parameters": [ { "name": "styleKey", "type": { "text": "string" } }, { "name": "sheet", "type": { "text": "string" } } ] }, { "kind": "method", "name": "register", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "styles", "type": { "text": "string" } } ] } ] } ], "exports": [ { "kind": "js", "name": "registerTransitionalStyles", "declaration": { "name": "registerTransitionalStyles", "module": "src/utils/transitional-styles/transitional-styles.ts" } }, { "kind": "js", "name": "TransitionalStyles", "declaration": { "name": "TransitionalStyles", "module": "src/utils/transitional-styles/transitional-styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/engine.ts", "declarations": [ { "kind": "variable", "name": "DEFAULT_SKIP_DIRS", "default": "new Set([ 'node_modules', '.git', 'dist', '.nx', '.cache', 'coverage', '.angular', '.next', '__pycache__', ])", "description": "Directories that are always skipped during file discovery." }, { "kind": "function", "name": "discoverFiles", "return": { "type": { "text": "" } }, "parameters": [ { "name": "basePath", "type": { "text": "string" }, "description": "Root directory to scan" }, { "name": "extensions", "type": { "text": "Set" }, "description": "Set of extensions to include (e.g. `new Set(['.ts', '.html'])`)" }, { "name": "skipDirs", "optional": true, "type": { "text": "Set" }, "description": "Directory names to skip (defaults to {@link DEFAULT_SKIP_DIRS})\n * " } ], "description": "Discover all files under `basePath` whose extension is in `extensions`." }, { "kind": "function", "name": "runMigrations", "return": { "type": { "text": "" } }, "parameters": [ { "name": "options", "type": { "text": "RunOptions" }, "description": "Configuration for the migration run" } ], "description": "Run one or more migration units against a directory tree.\n\nIn detect-only mode (default), files are scanned but never modified.\nIn apply mode (`apply: true`), each unit's `apply()` function is called\nand the result is written back to disk." } ], "exports": [ { "kind": "js", "name": "DEFAULT_SKIP_DIRS", "declaration": { "name": "DEFAULT_SKIP_DIRS", "module": "src/bin/context-cli/migrate/engine.ts" } }, { "kind": "js", "name": "discoverFiles", "declaration": { "name": "discoverFiles", "module": "src/bin/context-cli/migrate/engine.ts" } }, { "kind": "js", "name": "runMigrations", "declaration": { "name": "runMigrations", "module": "src/bin/context-cli/migrate/engine.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/index.ts", "declarations": [ { "kind": "variable", "name": "MIGRATE_HELP" }, { "kind": "function", "name": "handleMigrate", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "args", "type": { "text": "ParsedArgs" } } ], "description": "Route the `migrate` command to the appropriate subcommand." } ], "exports": [ { "kind": "js", "name": "MIGRATE_HELP", "declaration": { "name": "MIGRATE_HELP", "module": "src/bin/context-cli/migrate/index.ts" } }, { "kind": "js", "name": "handleMigrate", "declaration": { "name": "handleMigrate", "module": "src/bin/context-cli/migrate/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/registry.ts", "declarations": [ { "kind": "function", "name": "discoverMigrationUnits", "return": { "type": { "text": "" } }, "parameters": [ { "name": "basePath", "optional": true, "type": { "text": "string" }, "description": "Root `units/` directory to scan. Defaults to the\n co-located `./units` directory next to this module." } ], "description": "Discover migration units from the `units//` directory structure." }, { "kind": "function", "name": "getMigrationUnits", "return": { "type": { "text": "" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "{\n major?: number\n id?: string\n includeDisabled?: boolean\n basePath?: string\n}" } }, { "description": "Filter by target major version", "name": "options.major" }, { "description": "Filter by exact unit ID", "name": "options.id" }, { "description": "Include units with `enabled: false`", "name": "options.includeDisabled" }, { "description": "Override the units directory (for tests)", "name": "options.basePath" } ], "description": "Get migration units matching optional filter criteria.\n\nBy default only enabled units are returned. Set `includeDisabled: true`\nto include disabled units (useful for tooling / debugging)." } ], "exports": [ { "kind": "js", "name": "discoverMigrationUnits", "declaration": { "name": "discoverMigrationUnits", "module": "src/bin/context-cli/migrate/registry.ts" } }, { "kind": "js", "name": "getMigrationUnits", "declaration": { "name": "getMigrationUnits", "module": "src/bin/context-cli/migrate/registry.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/generated/react/alert/index.ts", "declarations": [ { "kind": "function", "name": "GdsAlert", "parameters": [ { "name": "props", "type": { "text": "GdsAlertProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsAlert", "declaration": { "name": "GdsAlert", "module": "src/generated/react/alert/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/backdrop/index.ts", "declarations": [ { "kind": "function", "name": "GdsBackdrop", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsBackdrop", "declaration": { "name": "GdsBackdrop", "module": "src/generated/react/backdrop/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/badge/index.ts", "declarations": [ { "kind": "function", "name": "GdsBadge", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ], "description": "`gds-badge`" } ], "exports": [ { "kind": "js", "name": "GdsBadge", "declaration": { "name": "GdsBadge", "module": "src/generated/react/badge/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/blur/index.ts", "declarations": [ { "kind": "function", "name": "GdsBlur", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsBlur", "declaration": { "name": "GdsBlur", "module": "src/generated/react/blur/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/breadcrumb/index.ts", "declarations": [ { "kind": "function", "name": "GdsBreadcrumb", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsBreadcrumb", "declaration": { "name": "GdsBreadcrumb", "module": "src/generated/react/breadcrumb/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/breadcrumbs/index.ts", "declarations": [ { "kind": "function", "name": "GdsBreadcrumbs", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsBreadcrumbs", "declaration": { "name": "GdsBreadcrumbs", "module": "src/generated/react/breadcrumbs/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/button/index.ts", "declarations": [ { "kind": "function", "name": "GdsButton", "parameters": [ { "name": "props", "type": { "text": "GdsButtonProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsButton", "declaration": { "name": "GdsButton", "module": "src/generated/react/button/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/calendar/index.ts", "declarations": [ { "kind": "function", "name": "GdsCalendar", "parameters": [ { "name": "props", "type": { "text": "GdsCalendarProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsCalendar", "declaration": { "name": "GdsCalendar", "module": "src/generated/react/calendar/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/card/index.ts", "declarations": [ { "kind": "function", "name": "GdsCard", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ], "description": "A container for content representing a single entity. e.g. a contact, article, or task.\n\n`gds-card` inherits all properties from `gds-div`, but comes with some predefined defaults\nand a shortcut property for specifying different card variants." } ], "exports": [ { "kind": "js", "name": "GdsCard", "declaration": { "name": "GdsCard", "module": "src/generated/react/card/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/card-linked/index.ts", "declarations": [ { "kind": "function", "name": "GdsCardLinked", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsCardLinked", "declaration": { "name": "GdsCardLinked", "module": "src/generated/react/card-linked/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/card-pattern-01/index.ts", "declarations": [ { "kind": "function", "name": "GdsCardPattern01", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsCardPattern01", "declaration": { "name": "GdsCardPattern01", "module": "src/generated/react/card-pattern-01/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/checkbox/index.ts", "declarations": [ { "kind": "function", "name": "GdsCheckbox", "parameters": [ { "name": "props", "type": { "text": "GdsCheckboxProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsCheckbox", "declaration": { "name": "GdsCheckbox", "module": "src/generated/react/checkbox/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/checkbox-group/index.ts", "declarations": [ { "kind": "function", "name": "GdsCheckboxGroup", "parameters": [ { "name": "props", "type": { "text": "GdsCheckboxGroupProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsCheckboxGroup", "declaration": { "name": "GdsCheckboxGroup", "module": "src/generated/react/checkbox-group/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/coachmark/index.ts", "declarations": [ { "kind": "function", "name": "GdsCoachmark", "parameters": [ { "name": "props", "type": { "text": "GdsCoachmarkProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsCoachmark", "declaration": { "name": "GdsCoachmark", "module": "src/generated/react/coachmark/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/context-menu/index.ts", "declarations": [ { "kind": "function", "name": "GdsContextMenu", "parameters": [ { "name": "props", "type": { "text": "GdsContextMenuProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsContextMenu", "declaration": { "name": "GdsContextMenu", "module": "src/generated/react/context-menu/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/datepicker/index.ts", "declarations": [ { "kind": "function", "name": "GdsDatepicker", "parameters": [ { "name": "props", "type": { "text": "GdsDatepickerProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsDatepicker", "declaration": { "name": "GdsDatepicker", "module": "src/generated/react/datepicker/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/details/index.ts", "declarations": [ { "kind": "function", "name": "GdsDetails", "parameters": [ { "name": "props", "type": { "text": "GdsDetailsProps & { ref?: React.Ref }" } } ], "description": "Details component that provides collapsible content sections." } ], "exports": [ { "kind": "js", "name": "GdsDetails", "declaration": { "name": "GdsDetails", "module": "src/generated/react/details/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/dialog/index.ts", "declarations": [ { "kind": "function", "name": "GdsDialog", "parameters": [ { "name": "props", "type": { "text": "GdsDialogProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsDialog", "declaration": { "name": "GdsDialog", "module": "src/generated/react/dialog/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/div/index.ts", "declarations": [ { "kind": "function", "name": "GdsDiv", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsDiv", "declaration": { "name": "GdsDiv", "module": "src/generated/react/div/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/divider/index.ts", "declarations": [ { "kind": "function", "name": "GdsDivider", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsDivider", "declaration": { "name": "GdsDivider", "module": "src/generated/react/divider/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/dropdown/index.ts", "declarations": [ { "kind": "function", "name": "GdsDropdown", "parameters": [ { "name": "props", "type": { "text": "GdsDropdownProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsDropdown", "declaration": { "name": "GdsDropdown", "module": "src/generated/react/dropdown/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/fab/index.ts", "declarations": [ { "kind": "function", "name": "GdsFab", "parameters": [ { "name": "props", "type": { "text": "GdsFabProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsFab", "declaration": { "name": "GdsFab", "module": "src/generated/react/fab/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/filter-chip/index.ts", "declarations": [ { "kind": "function", "name": "GdsFilterChip", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFilterChip", "declaration": { "name": "GdsFilterChip", "module": "src/generated/react/filter-chip/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/filter-chips/index.ts", "declarations": [ { "kind": "function", "name": "GdsFilterChips", "parameters": [ { "name": "props", "type": { "text": "GdsFilterChipsProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsFilterChips", "declaration": { "name": "GdsFilterChips", "module": "src/generated/react/filter-chips/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/flex/index.ts", "declarations": [ { "kind": "function", "name": "GdsFlex", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFlex", "declaration": { "name": "GdsFlex", "module": "src/generated/react/flex/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/form-summary/index.ts", "declarations": [ { "kind": "function", "name": "GdsFormSummary", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFormSummary", "declaration": { "name": "GdsFormSummary", "module": "src/generated/react/form-summary/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/formatted-account/index.ts", "declarations": [ { "kind": "function", "name": "GdsFormattedAccount", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFormattedAccount", "declaration": { "name": "GdsFormattedAccount", "module": "src/generated/react/formatted-account/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/formatted-date/index.ts", "declarations": [ { "kind": "function", "name": "GdsFormattedDate", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFormattedDate", "declaration": { "name": "GdsFormattedDate", "module": "src/generated/react/formatted-date/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/formatted-number/index.ts", "declarations": [ { "kind": "function", "name": "GdsFormattedNumber", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFormattedNumber", "declaration": { "name": "GdsFormattedNumber", "module": "src/generated/react/formatted-number/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/grid/index.ts", "declarations": [ { "kind": "function", "name": "GdsGrid", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ], "description": "The `gds-grid` is a custom element that provides a flexible grid system. It uses CSS grid layout to arrange its child elements into columns. This component is highly customizable and responsive, allowing you to specify the number of `columns`, `gap`, `padding`, and fluidity for different devices with automated column size based on the content using the `auto-columns` attribute." } ], "exports": [ { "kind": "js", "name": "GdsGrid", "declaration": { "name": "GdsGrid", "module": "src/generated/react/grid/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/grouped-list/index.ts", "declarations": [ { "kind": "function", "name": "GdsGroupedList", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsGroupedList", "declaration": { "name": "GdsGroupedList", "module": "src/generated/react/grouped-list/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/img/index.ts", "declarations": [ { "kind": "function", "name": "GdsImg", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsImg", "declaration": { "name": "GdsImg", "module": "src/generated/react/img/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/input/index.ts", "declarations": [ { "kind": "function", "name": "GdsInput", "parameters": [ { "name": "props", "type": { "text": "GdsInputProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsInput", "declaration": { "name": "GdsInput", "module": "src/generated/react/input/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/link/index.ts", "declarations": [ { "kind": "function", "name": "GdsLink", "parameters": [ { "name": "props", "type": { "text": "GdsLinkProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsLink", "declaration": { "name": "GdsLink", "module": "src/generated/react/link/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/list-item/index.ts", "declarations": [ { "kind": "function", "name": "GdsListItem", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsListItem", "declaration": { "name": "GdsListItem", "module": "src/generated/react/list-item/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/mask/index.ts", "declarations": [ { "kind": "function", "name": "GdsMask", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsMask", "declaration": { "name": "GdsMask", "module": "src/generated/react/mask/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/menu-button/index.ts", "declarations": [ { "kind": "function", "name": "GdsMenuButton", "parameters": [ { "name": "props", "type": { "text": "GdsMenuButtonProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsMenuButton", "declaration": { "name": "GdsMenuButton", "module": "src/generated/react/menu-button/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/menu-heading/index.ts", "declarations": [ { "kind": "function", "name": "GdsMenuHeading", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsMenuHeading", "declaration": { "name": "GdsMenuHeading", "module": "src/generated/react/menu-heading/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/menu-item/index.ts", "declarations": [ { "kind": "function", "name": "GdsMenuItem", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsMenuItem", "declaration": { "name": "GdsMenuItem", "module": "src/generated/react/menu-item/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/pagination/index.ts", "declarations": [ { "kind": "function", "name": "GdsPagination", "parameters": [ { "name": "props", "type": { "text": "GdsPaginationProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsPagination", "declaration": { "name": "GdsPagination", "module": "src/generated/react/pagination/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/option/index.ts", "declarations": [ { "kind": "function", "name": "GdsOption", "parameters": [ { "name": "props", "type": { "text": "GdsOptionProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsOption", "declaration": { "name": "GdsOption", "module": "src/generated/react/option/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/popover/index.ts", "declarations": [ { "kind": "function", "name": "GdsPopover", "parameters": [ { "name": "props", "type": { "text": "GdsPopoverProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsPopover", "declaration": { "name": "GdsPopover", "module": "src/generated/react/popover/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/radio/index.ts", "declarations": [ { "kind": "function", "name": "GdsRadio", "parameters": [ { "name": "props", "type": { "text": "GdsRadioProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsRadio", "declaration": { "name": "GdsRadio", "module": "src/generated/react/radio/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/radio-group/index.ts", "declarations": [ { "kind": "function", "name": "GdsRadioGroup", "parameters": [ { "name": "props", "type": { "text": "GdsRadioGroupProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsRadioGroup", "declaration": { "name": "GdsRadioGroup", "module": "src/generated/react/radio-group/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/rich-text/index.ts", "declarations": [ { "kind": "function", "name": "GdsRichText", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ], "description": "`gds-rich-text` can be used to wrap generic HTML content and apply typography styles.\n\nThe wrapped content will render inside the shadowRoot of the `gds-rich-text` element, thereby applying the\ndefault typography styles and standard element styles defined in the Green Design System." } ], "exports": [ { "kind": "js", "name": "GdsRichText", "declaration": { "name": "GdsRichText", "module": "src/generated/react/rich-text/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/segment/index.ts", "declarations": [ { "kind": "function", "name": "GdsSegment", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSegment", "declaration": { "name": "GdsSegment", "module": "src/generated/react/segment/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/segmented-control/index.ts", "declarations": [ { "kind": "function", "name": "GdsSegmentedControl", "parameters": [ { "name": "props", "type": { "text": "GdsSegmentedControlProps & {\n ref?: React.Ref\n }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSegmentedControl", "declaration": { "name": "GdsSegmentedControl", "module": "src/generated/react/segmented-control/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/select/index.ts", "declarations": [ { "kind": "function", "name": "GdsSelect", "parameters": [ { "name": "props", "type": { "text": "GdsSelectProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsSelect", "declaration": { "name": "GdsSelect", "module": "src/generated/react/select/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/sensitive-account/index.ts", "declarations": [ { "kind": "function", "name": "GdsSensitiveAccount", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSensitiveAccount", "declaration": { "name": "GdsSensitiveAccount", "module": "src/generated/react/sensitive-account/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/sensitive-date/index.ts", "declarations": [ { "kind": "function", "name": "GdsSensitiveDate", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSensitiveDate", "declaration": { "name": "GdsSensitiveDate", "module": "src/generated/react/sensitive-date/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/sensitive-number/index.ts", "declarations": [ { "kind": "function", "name": "GdsSensitiveNumber", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSensitiveNumber", "declaration": { "name": "GdsSensitiveNumber", "module": "src/generated/react/sensitive-number/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/signal/index.ts", "declarations": [ { "kind": "function", "name": "GdsSignal", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSignal", "declaration": { "name": "GdsSignal", "module": "src/generated/react/signal/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/spinner/index.ts", "declarations": [ { "kind": "function", "name": "GdsSpinner", "parameters": [ { "name": "props", "type": { "text": "GdsSpinnerProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSpinner", "declaration": { "name": "GdsSpinner", "module": "src/generated/react/spinner/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/table/index.ts", "declarations": [ { "kind": "function", "name": "GdsTable", "parameters": [ { "name": "props", "type": { "text": "GdsTableProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsTable", "declaration": { "name": "GdsTable", "module": "src/generated/react/table/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/text/index.ts", "declarations": [ { "kind": "function", "name": "GdsText", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsText", "declaration": { "name": "GdsText", "module": "src/generated/react/text/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/textarea/index.ts", "declarations": [ { "kind": "function", "name": "GdsTextarea", "parameters": [ { "name": "props", "type": { "text": "GdsTextareaProps & { ref?: React.Ref }" } } ] }, { "kind": "variable", "name": "ref" } ], "exports": [ { "kind": "js", "name": "GdsTextarea", "declaration": { "name": "GdsTextarea", "module": "src/generated/react/textarea/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/theme/index.ts", "declarations": [ { "kind": "function", "name": "GdsTheme", "parameters": [ { "name": "props", "type": { "text": "GdsThemeProps & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsTheme", "declaration": { "name": "GdsTheme", "module": "src/generated/react/theme/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/video/index.ts", "declarations": [ { "kind": "function", "name": "GdsVideo", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ], "description": "`gds-video` is a custom video element that provides configurable .mp4 video playback that can be used as background or hero video without controls.\nThe video can be customized with different properties like ratio, position, inset, width, height, opacity, fit, and radius." } ], "exports": [ { "kind": "js", "name": "GdsVideo", "declaration": { "name": "GdsVideo", "module": "src/generated/react/video/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumbs/breadcrumb/breadcrumb.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsBreadcrumb", "slots": [ { "description": "Default slot for the breadcrumb content", "name": "" }, { "description": "Optional slot for leading content (usually icons)", "name": "lead" }, { "description": "Optional slot for trailing content", "name": "trail" } ], "members": [ { "kind": "field", "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the breadcrumb item points to.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Where to display the linked breadcrumb URL. Only used when href is present.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked breadcrumb URL. Defaults to \"noreferrer noopener\" when target is \"_blank\".", "attribute": "rel" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "Accessible label for the breadcrumb item. Use when visual text needs a different description.", "attribute": "label" }, { "kind": "field", "name": "overflow", "type": { "text": "boolean" }, "default": "false", "description": "When true, the breadcrumb item will render as an overflow menu instead of a regular link.", "attribute": "overflow", "reflects": true, "category": "Declarative layout / Style expression properties" }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "href", "type": { "text": "string" }, "default": "''", "description": "The URL that the breadcrumb item points to.", "fieldName": "href" }, { "name": "target", "type": { "text": "'_self' | '_blank' | '_parent' | '_top' | undefined" }, "description": "Where to display the linked breadcrumb URL. Only used when href is present.", "fieldName": "target" }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked breadcrumb URL. Defaults to \"noreferrer noopener\" when target is \"_blank\".", "fieldName": "rel" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "Accessible label for the breadcrumb item. Use when visual text needs a different description.", "fieldName": "label" }, { "name": "overflow", "type": { "text": "boolean" }, "default": "false", "description": "When true, the breadcrumb item will render as an overflow menu instead of a regular link.", "fieldName": "overflow", "category": "Declarative layout / Style expression properties" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-breadcrumb", "customElement": true, "summary": "The `gds-breadcrumb` component represents a single item within a breadcrumb navigation.\nIt can be rendered as a link, current page indicator, or overflow menu depending on its properties.", "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsBreadcrumb", "declaration": { "name": "GdsBreadcrumb", "module": "src/components/breadcrumbs/breadcrumb/breadcrumb.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumbs/breadcrumb/breadcrumb.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base { :host { display: contents; } .list-item { display: flex; align-items: center; justify-content: center; list-style: none; margin: unset; padding: unset; height: max-content; font-weight: inherit; font-size: inherit; line-height: inherit; gap: var(--_gap); } @container (max-width: 400px) { :host(:not([return])) { display: none; } :host([return]) { display: contents; } } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/breadcrumbs/breadcrumb/breadcrumb.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumbs/breadcrumb/breadcrumb.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsBreadcrumb", "declaration": { "name": "GdsBreadcrumb", "module": "src/components/breadcrumbs/breadcrumb/breadcrumb.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumbs/breadcrumb/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/breadcrumbs/breadcrumb/breadcrumb" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox-group/checkbox-group.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsCheckboxGroup", "mixins": [ { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" }, "tagName": "gds-checkbox-group", "customElement": true, "summary": "A form control component for grouping checkbox buttons.", "members": [ { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size of label and supporting text on group form control header and single checkbox buttons respectively.", "attribute": "size", "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "kind": "field", "name": "flexDirection", "type": { "text": "'row' | 'column'" }, "default": "'column'", "description": "The flex-direction in which checkbox buttons are displayed.", "attribute": "flex-direction", "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "kind": "field", "name": "hideLabel", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the label for the checkbox group. Usable if you want a single checkbox to act as the label.", "attribute": "hide-label", "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "kind": "field", "name": "supportingText", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field.\nThis text provides additional context or information to the user.", "attribute": "supporting-text", "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "kind": "field", "name": "showExtendedSupportingText", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "attribute": "show-extended-supporting-text", "reflects": true, "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "kind": "field", "name": "value", "description": "Get or set the value of the form control.", "attribute": "value", "type": { "text": "string[]" }, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "checkboxes", "type": { "text": "GdsCheckbox[]" }, "description": "Returns an array of `` elements in the checkbox group.", "readonly": true, "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "kind": "method", "name": "focus", "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size of label and supporting text on group form control header and single checkbox buttons respectively.", "fieldName": "size", "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "name": "flex-direction", "type": { "text": "'row' | 'column'" }, "default": "'column'", "description": "The flex-direction in which checkbox buttons are displayed.", "fieldName": "flexDirection", "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "name": "hide-label", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the label for the checkbox group. Usable if you want a single checkbox to act as the label.", "fieldName": "hideLabel", "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "name": "supporting-text", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field.\nThis text provides additional context or information to the user.", "fieldName": "supportingText", "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "name": "show-extended-supporting-text", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "fieldName": "showExtendedSupportingText", "inheritedFrom": { "name": "CheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } }, { "name": "value", "description": "Get or set the value of the form control.", "fieldName": "value", "type": { "text": "string[]" }, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "fieldName": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsCheckboxGroup", "declaration": { "name": "GdsCheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox-group/checkbox-group.styles.ts", "declarations": [ { "kind": "variable", "name": "styles", "default": "css` :host { /* Font Sizes */ --_font-label: var(--gds-sys-text-detail-m-book); --_font-supporting-text: var(--gds-sys-text-detail-s-regular); font: var(--_font-label); /* Color */ --_checkbox-label-color: var(--gds-sys-color-l3-content-tertiary); /* Perimiter */ --_perimeter-size: var(--gds-sys-space-2xl); --_container-gap: var(--gds-sys-space-s); } :host(:invalid) { --_checkbox-label-color: var(--gds-sys-color-content-negative-01); } :host([size='small']) { --_font-label: var(--gds-sys-text-detail-s-book); --_font-supporting-text: var(--gds-sys-text-detail-xs-regular); --_perimeter-size: var(--gds-sys-space-xl); --_container-gap: var(--gds-sys-space-xs); } .checkbox-group { display: flex; flex-direction: column; gap: var(--gds-sys-space-m); } :host([size='small']) .checkbox-group { gap: var(--gds-sys-space-xs); } .content { display: flex; position: relative; max-width: max-content; color: var(--_checkbox-label-color); } .direction-row .content { flex-direction: row; flex-wrap: wrap; gap: var(--gds-sys-space-s) var(--gds-sys-space-xl); } .direction-column .content { flex-direction: column; gap: var(--gds-sys-space-s); } :host([size='small']) .direction-column .content { gap: var(--gds-sys-space-xs); } :host([size='small']) .direction-row .content { gap: var(--gds-sys-space-xs) var(--gds-sys-space-m); } .visually-hidden { border: 0; clip: rect(0 0 0 0); height: 1px; margin: -1px; overflow: hidden; padding: 0; position: absolute; width: 1px; } `" } ], "exports": [ { "kind": "js", "name": "styles", "declaration": { "name": "styles", "module": "src/components/checkbox/checkbox-group/checkbox-group.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox-group/checkbox-group.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsCheckboxGroup", "declaration": { "name": "GdsCheckboxGroup", "module": "src/components/checkbox/checkbox-group/checkbox-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/details/details-icon/details-icon.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsIconDetails", "members": [ { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Controls if the details is open", "attribute": "open", "reflects": true }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Controls if the details is open", "fieldName": "open" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-icon-details", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsIconDetails", "declaration": { "name": "GdsIconDetails", "module": "src/components/details/details-icon/details-icon.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/details/details-icon/details-icon.style.ts", "declarations": [ { "kind": "variable", "name": "styles", "default": "css` :host { display: contents; } `" } ], "exports": [ { "kind": "js", "name": "styles", "declaration": { "name": "styles", "module": "src/components/details/details-icon/details-icon.style.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/details/details-icon/details-icon.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsIconDetails", "declaration": { "name": "GdsIconDetails", "module": "src/components/details/details-icon/details-icon.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chip/filter-chip.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsFilterChip", "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the chip is selected", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "ValueT | undefined" }, "description": "The value of the chip", "attribute": "value" }, { "kind": "field", "name": "size", "type": { "text": "'small' | 'large'" }, "default": "'large'", "description": "The size of the chip", "attribute": "size", "reflects": true }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the chip is selected", "fieldName": "selected" }, { "name": "value", "type": { "text": "ValueT | undefined" }, "description": "The value of the chip", "fieldName": "value" }, { "name": "size", "type": { "text": "'small' | 'large'" }, "default": "'large'", "description": "The size of the chip", "fieldName": "size" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-filter-chip", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFilterChip", "declaration": { "name": "GdsFilterChip", "module": "src/components/filter-chips/filter-chip/filter-chip.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chip/filter-chip.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Filter Chips/Filter Chip', component: 'gds-filter-chip', parameters: { layout: 'centered', }, tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-filter-chip'), size: { options: ['small', 'large'], control: { type: 'select' }, }, }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/filter-chips)\n | \n[Usage guidelines](https://designlibrary.sebgroup.com/components/component-filter-chip)\n\nThe filter chip is a sub-component of the filter chips component, and should generally not be used on its own." }, { "kind": "variable", "name": "Basic", "type": { "text": "Story" }, "default": "{ ...DefaultParams, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/filter-chips/filter-chip/filter-chip.stories.ts" } }, { "kind": "js", "name": "Basic", "declaration": { "name": "Basic", "module": "src/components/filter-chips/filter-chip/filter-chip.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chip/filter-chip.styles.ts", "declarations": [ { "kind": "variable", "name": "styles", "default": "css` @layer base, reset, transitional-styles; @layer base { .icon { width: 1rem; } } `" } ], "exports": [ { "kind": "js", "name": "styles", "declaration": { "name": "styles", "module": "src/components/filter-chips/filter-chip/filter-chip.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chip/filter-chip.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/filter-chips/filter-chip/filter-chip.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/filter-chips/filter-chip/filter-chip.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chip/filter-chip.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFilterChip", "declaration": { "name": "GdsFilterChip", "module": "src/components/filter-chips/filter-chip/filter-chip.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/filter-chips/filter-chip/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/filter-chips/filter-chip/filter-chip" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/date/date-time-formatter.ts", "declarations": [ { "kind": "variable", "name": "dateTimeFormats", "default": "{ dateOnlyNumbers: (value, locale) => new Intl.DateTimeFormat(locale, { dateStyle: 'short' }).format( convertValueToDate(value), ), dateLong: (value, locale) => new Intl.DateTimeFormat(locale, { dateStyle: 'long' }).format( convertValueToDate(value), ), dateLongWithWeekday: (value, locale) => new Intl.DateTimeFormat(locale, { dateStyle: 'full' }) .format(convertValueToDate(value)) .replace(',', ''), dateShort: (value, locale) => { const formatter = new Intl.DateTimeFormat(locale, { dateStyle: 'medium' }) if (locale?.toLowerCase() === 'sv-se') { return formatter.format(convertValueToDate(value)).replace('.', '') } return formatter.format(convertValueToDate(value)) }, dateShortWithWeekday: (value, locale) => { const formatted = new Intl.DateTimeFormat(locale, { weekday: 'short', year: 'numeric', month: 'short', day: 'numeric', }).format(convertValueToDate(value)) if (locale?.toLowerCase() === 'sv-se') { return formatted.replace('.', '') } if (locale?.toLowerCase() === 'en-gb') { return formatted.replace(',', '') } return formatted }, timeShort: (value, locale) => new Intl.DateTimeFormat(locale, { timeStyle: 'short' }).format( convertValueToDate(value), ), timeLong: (value, locale) => new Intl.DateTimeFormat(locale, { timeStyle: 'medium' }).format( convertValueToDate(value), ), dateTimeLong: (value, locale) => { return new Intl.DateTimeFormat(locale, { dateStyle: 'long', timeStyle: 'short', }).format(convertValueToDate(value)) }, dateTimeLongWithWeekday: (value, locale) => { return new Intl.DateTimeFormat(locale, { dateStyle: 'full', timeStyle: 'short', }).format(convertValueToDate(value)) }, dateTimeShort: (value, locale) => { return new Intl.DateTimeFormat(locale, { dateStyle: 'medium', timeStyle: 'short', }).format(convertValueToDate(value)) }, } satisfies Record" } ], "exports": [ { "kind": "js", "name": "dateTimeFormats", "declaration": { "name": "dateTimeFormats", "module": "src/components/formatted-text/date/date-time-formatter.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/date/formatted-date.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsFormattedDate", "members": [ { "kind": "field", "name": "value", "type": { "text": "Date | string | undefined" }, "description": "The date value to be formatted, either Date or ISO string." }, { "kind": "field", "name": "format", "type": { "text": "DateTimeFormat" }, "default": "'dateOnlyNumbers'", "description": "Specifies the date format.", "attribute": "format" }, { "kind": "field", "name": "locale", "type": { "text": "string | undefined" }, "description": "The locale used for date formatting.", "attribute": "locale" }, { "kind": "field", "name": "formattedValue", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "GdsFormattedText", "module": "src/components/formatted-text/formatted-text.ts" } }, { "kind": "field", "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "attribute": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-transform'", "type": { "text": "string | undefined" }, "description": "Controls the text-transform property of the text.\nSupports all valid CSS text-transform values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'text-decoration'", "type": { "text": "string | undefined" }, "description": "Controls the text-decoration property of the inner element.\nSupports all valid CSS text-decoration values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "lines", "type": { "text": "number | undefined" }, "description": "Controls the number of lines it should show.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "format", "type": { "text": "DateTimeFormat" }, "default": "'dateOnlyNumbers'", "description": "Specifies the date format.", "fieldName": "format" }, { "name": "locale", "type": { "text": "string | undefined" }, "description": "The locale used for date formatting.", "fieldName": "locale" }, { "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "fieldName": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsFormattedText", "module": "/src/components/formatted-text/formatted-text" }, "tagName": "gds-formatted-date", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFormattedDate", "declaration": { "name": "GdsFormattedDate", "module": "src/components/formatted-text/date/formatted-date.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/date/formatted-date.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Formatted text/Date and time', component: 'gds-formatted-date', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-formatted-date'), }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/formatted-text/date)\n\n`gds-formatted-date` extends `gds-text` and formats the date to the desired format." }, { "kind": "variable", "name": "Formats", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Formats', render: (args) => html` ${formats.map( (format) => html` ${format.name}: ${args.value} `, )} `, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/formatted-text/date/formatted-date.stories.ts" } }, { "kind": "js", "name": "Formats", "declaration": { "name": "Formats", "module": "src/components/formatted-text/date/formatted-date.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/date/formatted-date.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFormattedDate", "declaration": { "name": "GdsFormattedDate", "module": "src/components/formatted-text/date/formatted-date.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/date/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/formatted-text/date/formatted-date" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/account/account-formatter.ts", "declarations": [ { "kind": "variable", "name": "accountsFormats", "default": "{ 'seb-account': (value) => { const account = typeof value === 'string' ? value.replace(' ', '') : (value?.toString() ?? '') if (account.length !== 11) { return account } return `${account.slice(0, 4)} ${account.slice(4, 6)} ${account.slice(6, 9)} ${account.slice(9, 11)}` }, } satisfies Record" } ], "exports": [ { "kind": "js", "name": "accountsFormats", "declaration": { "name": "accountsFormats", "module": "src/components/formatted-text/account/account-formatter.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/account/formatted-account.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsFormattedAccount", "members": [ { "kind": "field", "name": "account", "type": { "text": "number | string | undefined" }, "description": "The account number or identifier to display.\nFor format 'seb-account', it needs to be 11 characters.", "attribute": "account" }, { "kind": "field", "name": "formattedValue", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "GdsFormattedText", "module": "src/components/formatted-text/formatted-text.ts" } }, { "kind": "field", "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "attribute": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-transform'", "type": { "text": "string | undefined" }, "description": "Controls the text-transform property of the text.\nSupports all valid CSS text-transform values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'text-decoration'", "type": { "text": "string | undefined" }, "description": "Controls the text-decoration property of the inner element.\nSupports all valid CSS text-decoration values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "lines", "type": { "text": "number | undefined" }, "description": "Controls the number of lines it should show.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "account", "type": { "text": "number | string | undefined" }, "description": "The account number or identifier to display.\nFor format 'seb-account', it needs to be 11 characters.", "fieldName": "account" }, { "name": "format", "type": { "text": "AccountFormats" }, "default": "'seb-account'", "description": "Specifies the account format.", "fieldName": "format" }, { "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "fieldName": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsFormattedText", "module": "/src/components/formatted-text/formatted-text" }, "tagName": "gds-formatted-account", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFormattedAccount", "declaration": { "name": "GdsFormattedAccount", "module": "src/components/formatted-text/account/formatted-account.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/account/formatted-account.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Formatted text/Accounts', component: 'gds-formatted-account', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-formatted-account'), format: { control: { type: 'select' }, options: Object.keys(accountsFormats), }, }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/formatted-text/account)\n\n`gds-formatted-account` extends `gds-text` and formats the account to the desired format." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'SEB Account', render: (args) => html` ${args.account} `, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/formatted-text/account/formatted-account.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/formatted-text/account/formatted-account.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/account/formatted-account.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFormattedAccount", "declaration": { "name": "GdsFormattedAccount", "module": "src/components/formatted-text/account/formatted-account.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/account/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/formatted-text/account/formatted-account" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/number/formatted-number.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsFormattedNumber", "members": [ { "kind": "field", "name": "value", "type": { "text": "number | string | undefined" }, "description": "The numerical value to display." }, { "kind": "field", "name": "locale", "type": { "text": "string | undefined" }, "description": "The locale used for number formatting.", "attribute": "locale" }, { "kind": "field", "name": "currency", "type": { "text": "string | undefined" }, "description": "The currency used when formatting numbers.", "attribute": "currency" }, { "kind": "field", "name": "decimals", "type": { "text": "number | undefined" }, "description": "The number of decimal places to display.", "attribute": "decimals" }, { "kind": "field", "name": "formattedValue", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "GdsFormattedText", "module": "src/components/formatted-text/formatted-text.ts" } }, { "kind": "field", "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "attribute": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-transform'", "type": { "text": "string | undefined" }, "description": "Controls the text-transform property of the text.\nSupports all valid CSS text-transform values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'text-decoration'", "type": { "text": "string | undefined" }, "description": "Controls the text-decoration property of the inner element.\nSupports all valid CSS text-decoration values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "lines", "type": { "text": "number | undefined" }, "description": "Controls the number of lines it should show.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "locale", "type": { "text": "string | undefined" }, "description": "The locale used for number formatting.", "fieldName": "locale" }, { "name": "currency", "type": { "text": "string | undefined" }, "description": "The currency used when formatting numbers.", "fieldName": "currency" }, { "name": "decimals", "type": { "text": "number | undefined" }, "description": "The number of decimal places to display.", "fieldName": "decimals" }, { "name": "format", "type": { "text": "NumberFormats" }, "default": "'decimalsAndThousands'", "description": "Specifies the number format.", "fieldName": "format" }, { "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "fieldName": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsFormattedText", "module": "/src/components/formatted-text/formatted-text" }, "tagName": "gds-formatted-number", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsFormattedNumber", "declaration": { "name": "GdsFormattedNumber", "module": "src/components/formatted-text/number/formatted-number.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/number/formatted-number.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Formatted text/Number', component: 'gds-formatted-number', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-formatted-number'), format: { control: { type: 'select' }, options: Object.keys(numberFormats), }, currency: { type: 'string', }, decimals: { type: 'number', }, }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/formatted-text/number)\n\n`gds-formatted-number` extends `gds-text` and formats the number to the desired format." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Default', render: (args) => html` ${args.value}`, }" }, { "kind": "variable", "name": "Currencies", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Currencies', render: (args) => html` ${currencies.map( (currency) => html` ${currency}: `, )} `, }" }, { "kind": "variable", "name": "Decimals", "type": { "text": "Story" }, "default": "{ ...DefaultParams, name: 'Decimals', render: (args) => html` ${decimals.map( (currency) => html` ${currency}: `, )} `, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/formatted-text/number/formatted-number.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/formatted-text/number/formatted-number.stories.ts" } }, { "kind": "js", "name": "Currencies", "declaration": { "name": "Currencies", "module": "src/components/formatted-text/number/formatted-number.stories.ts" } }, { "kind": "js", "name": "Decimals", "declaration": { "name": "Decimals", "module": "src/components/formatted-text/number/formatted-number.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/number/formatted-number.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsFormattedNumber", "declaration": { "name": "GdsFormattedNumber", "module": "src/components/formatted-text/number/formatted-number.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/number/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/formatted-text/number/formatted-number" } } ] }, { "kind": "javascript-module", "path": "src/components/formatted-text/number/number-formatter.ts", "declarations": [ { "kind": "variable", "name": "numberFormats", "default": "{ decimalsAndThousands: (value, locale, currency, decimals) => { const options: Intl.NumberFormatOptions = { maximumFractionDigits: decimals ?? 2, minimumFractionDigits: decimals ?? 2, } if (currency) { return new Intl.NumberFormat(locale, { ...options, style: 'currency', currency: currency, }).format(Number(value)) } return new Intl.NumberFormat(locale, options).format(Number(value)) }, } satisfies Record" } ], "exports": [ { "kind": "js", "name": "numberFormats", "declaration": { "name": "numberFormats", "module": "src/components/formatted-text/number/number-formatter.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/account/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/sensitive/account/sensitive-account" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/account/sensitive-account.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsSensitiveAccount", "members": [ { "kind": "field", "name": "hide", "type": { "text": "boolean" }, "default": "false", "description": "When true, hides the sensitive account.", "attribute": "hide" }, { "kind": "field", "name": "account", "type": { "text": "number | string | undefined" }, "description": "The account number or identifier to display.\nFor format 'seb-account', it needs to be 11 characters.", "attribute": "account", "inheritedFrom": { "name": "GdsFormattedAccount", "module": "src/components/formatted-text/account/formatted-account.component.ts" } }, { "kind": "field", "name": "formattedValue", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "GdsFormattedText", "module": "src/components/formatted-text/formatted-text.ts" } }, { "kind": "field", "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "attribute": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-transform'", "type": { "text": "string | undefined" }, "description": "Controls the text-transform property of the text.\nSupports all valid CSS text-transform values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'text-decoration'", "type": { "text": "string | undefined" }, "description": "Controls the text-decoration property of the inner element.\nSupports all valid CSS text-decoration values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "lines", "type": { "text": "number | undefined" }, "description": "Controls the number of lines it should show.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "hide", "type": { "text": "boolean" }, "default": "false", "description": "When true, hides the sensitive account.", "fieldName": "hide" }, { "name": "account", "type": { "text": "number | string | undefined" }, "description": "The account number or identifier to display.\nFor format 'seb-account', it needs to be 11 characters.", "fieldName": "account", "inheritedFrom": { "name": "GdsFormattedAccount", "module": "src/components/formatted-text/account/formatted-account.component.ts" } }, { "name": "format", "type": { "text": "AccountFormats" }, "default": "'seb-account'", "description": "Specifies the account format.", "fieldName": "format", "inheritedFrom": { "name": "GdsFormattedAccount", "module": "src/components/formatted-text/account/formatted-account.component.ts" } }, { "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "fieldName": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsFormattedAccount", "module": "/src/components/formatted-text/account/formatted-account.component" }, "tagName": "gds-sensitive-account", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSensitiveAccount", "declaration": { "name": "GdsSensitiveAccount", "module": "src/components/sensitive/account/sensitive-account.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/account/sensitive-account.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Sensitive/Account', component: 'gds-sensitive-account', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-sensitive-account'), format: { control: { type: 'select' }, options: Object.keys(accountsFormats), }, }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/sensitive/account)\n\nGdsSensitiveAccount displays a formatted account and optionally hides it using a blur effect\nwhen the 'hide' property is set to true." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html``, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/sensitive/account/sensitive-account.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/sensitive/account/sensitive-account.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/account/sensitive-account.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsSensitiveAccount", "declaration": { "name": "GdsSensitiveAccount", "module": "src/components/sensitive/account/sensitive-account.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/segment/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/segmented-control/segment/segment" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/segment/segment.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsSegment", "members": [ { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the segment is selected", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "ValueT | undefined" }, "description": "Value can be used to tie arbitrary data to the segment.", "attribute": "value" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the segment is disabled.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "isVisible", "description": "Whether the segment is currently visible.", "readonly": true }, { "kind": "field", "name": "_isVisible", "type": { "text": "boolean" }, "default": "true" }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the segment is selected", "fieldName": "selected", "attribute": "selected" }, { "name": "value", "type": { "text": "ValueT | undefined" }, "description": "Value can be used to tie arbitrary data to the segment.", "fieldName": "value", "attribute": "value" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the segment is disabled.", "fieldName": "disabled" }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "GdsElement", "module": "/src/gds-element" }, "tagName": "gds-segment", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSegment", "declaration": { "name": "GdsSegment", "module": "src/components/segmented-control/segment/segment.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/segment/segment.styles.ts", "declarations": [ { "kind": "variable", "name": "style", "default": "css` @layer base { :host { display: flex; z-index: 1; } button { appearance: none; background: transparent; border-radius: var(--gds-sys-radius-max); border-width: 0; color: var(--gds-sys-color-content-neutral-02); cursor: pointer; flex-grow: 1; flex-shrink: 0; font-family: inherit; font-size: inherit; font: var(--gds-sys-text-detail-m-book); overflow: hidden; padding: 0 1rem; text-align: center; text-overflow: ellipsis; white-space: nowrap; width: 100%; transition: background-color var(--gds-sys-motion-duration-fast), border-color var(--gds-sys-motion-duration-fast), color var(--gds-sys-motion-duration-fast); outline-width: var(--gds-sys-space-4xs); outline-style: solid; outline-offset: -4px; outline-color: transparent; &:disabled { cursor: not-allowed; opacity: 0.5; } } :host([selected]) button { color: var(--gds-sys-color-content-neutral-03); } @media (pointer: fine) { :host(:not([selected])) button:hover { background-color: color-mix( in srgb, transparent, var(--gds-sys-color-state-neutral-05) ); &:disabled { background-color: transparent; } } } button:focus-visible { outline-color: color-mix( in srgb, transparent, var(--gds-sys-color-l3-content-tertiary) 100% ); } } `" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "style", "module": "src/components/segmented-control/segment/segment.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/segment/segment.trans.styles.ts", "declarations": [ { "kind": "function", "name": "register" } ], "exports": [ { "kind": "js", "name": "register", "declaration": { "name": "register", "module": "src/components/segmented-control/segment/segment.trans.styles.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "register", "module": "src/components/segmented-control/segment/segment.trans.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/segmented-control/segment/segment.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsSegment", "declaration": { "name": "GdsSegment", "module": "src/components/segmented-control/segment/segment.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/radio-group/radio-group.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsRadioGroup", "slots": [ { "description": "Default slot for radio buttons (accepts `gds-radio` elements)", "name": "" }, { "description": "A longer supporting text that will be displayed in a panel when the user clicks the info button", "name": "extended-supporting-text" } ], "events": [ { "description": "Fired when a radio button selection changes", "name": "change" }, { "description": "Fired when a radio button selection changes", "name": "input" }, { "description": "Dispatched when the validity state of the form control is changed by a validator.", "name": "gds-validity-state", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "mixins": [ { "name": "withLayoutChildProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withMarginProps", "module": "/src/utils/mixins/declarative-layout-mixins" }, { "name": "withSizeXProps", "module": "/src/utils/mixins/declarative-layout-mixins" } ], "superclass": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" }, "tagName": "gds-radio-group", "customElement": true, "summary": "A form control component for grouping radio buttons.", "members": [ { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size of label and supporting text on group form control header and single radio buttons respectively.", "attribute": "size", "inheritedFrom": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } }, { "kind": "field", "name": "flexDirection", "type": { "text": "'row' | 'column'" }, "default": "'column'", "description": "The flex-direction in which radio buttons are displayed.", "attribute": "flex-direction", "inheritedFrom": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } }, { "kind": "field", "name": "supportingText", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field.\nThis text provides additional context or information to the user.", "attribute": "supporting-text", "inheritedFrom": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } }, { "kind": "field", "name": "showExtendedSupportingText", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "attribute": "show-extended-supporting-text", "reflects": true, "inheritedFrom": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } }, { "kind": "field", "name": "radios", "type": { "text": "GdsRadio[]" }, "description": "Returns an array of `` elements in the radio group.", "readonly": true, "inheritedFrom": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } }, { "kind": "method", "name": "focus", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "inheritedFrom": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validator", "type": { "text": "GdsValidator | undefined" }, "description": "A validator that can be used to validate the form control and set an error message.", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "attribute": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "attribute": "error-message", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "invalid", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "attribute": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "value", "description": "Get or set the value of the form control.", "attribute": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "''", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "form", "description": "The form element that the form control is associated with.", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validity", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "validationMessage", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "field", "name": "willValidate", "readonly": true, "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "checkValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "reportValidity", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "size", "type": { "text": "'large' | 'small'" }, "default": "'large'", "description": "Controls the font-size of label and supporting text on group form control header and single radio buttons respectively.", "fieldName": "size", "inheritedFrom": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } }, { "name": "flex-direction", "type": { "text": "'row' | 'column'" }, "default": "'column'", "description": "The flex-direction in which radio buttons are displayed.", "fieldName": "flexDirection", "inheritedFrom": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } }, { "name": "supporting-text", "type": { "text": "string" }, "default": "''", "description": "The supporting text displayed between the label and the field.\nThis text provides additional context or information to the user.", "fieldName": "supportingText", "inheritedFrom": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } }, { "name": "show-extended-supporting-text", "type": { "text": "boolean" }, "default": "false", "description": "Whether the supporting text should be displayed or not.", "fieldName": "showExtendedSupportingText", "inheritedFrom": { "name": "RadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } }, { "name": "aria-invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "The required attribute can be used to communicate to users of assistive technology that the control is required. Validation still needs to be done in a validator or equivalent.", "fieldName": "required", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "error-message", "type": { "text": "string" }, "default": "''", "description": "This can be used to manually control the error message that will be displayed\nwhen the control is invalid.", "fieldName": "errorMessage", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "invalid", "description": "Validation state of the form control. Setting this to true triggers the invalid state of the control.", "attribute": "aria-invalid", "fieldName": "invalid", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label of the form control.", "fieldName": "label", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "value", "description": "Get or set the value of the form control.", "fieldName": "value", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "fieldName": "name", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "If the input is Disabled", "fieldName": "disabled", "inheritedFrom": { "name": "GdsFormControlElement", "module": "src/components/form/form-control.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsRadioGroup", "declaration": { "name": "GdsRadioGroup", "module": "src/components/radio/radio-group/radio-group.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/radio-group/radio-group.styles.ts", "declarations": [ { "kind": "variable", "name": "styles", "default": "css` :host { /* Font Sizes */ --_font-label: var(--gds-sys-text-detail-m-book); --_font-supporting-text: var(--gds-sys-text-detail-s-regular); font: var(--_font-label); /* Color */ --_radio-label-color: var(--gds-sys-color-l3-content-tertiary); } :host(:invalid) { --_radio-label-color: var(--gds-sys-color-content-negative-01); } :host([size='small']) { --_font-label: var(--gds-sys-text-detail-s-book); --_font-supporting-text: var(--gds-sys-text-detail-xs-regular); --_perimeter-size: var(--gds-sys-space-xl); --_container-gap: var(--gds-sys-space-xs); } .radio-group { display: flex; flex-direction: column; gap: var(--gds-sys-space-m); } :host([size='small']) .radio-group { gap: var(--gds-sys-space-xs); } .content { display: flex; position: relative; max-width: max-content; color: var(--_radio-label-color); } .direction-row .content { flex-direction: row; flex-wrap: wrap; gap: var(--gds-sys-space-s) var(--gds-sys-space-xl); } .direction-column .content { flex-direction: column; gap: var(--gds-sys-space-s); } :host([size='small']) .direction-column .content { gap: var(--gds-sys-space-xs); } :host([size='small']) .direction-row .content { gap: var(--gds-sys-space-xs) var(--gds-sys-space-m); } `" } ], "exports": [ { "kind": "js", "name": "styles", "declaration": { "name": "styles", "module": "src/components/radio/radio-group/radio-group.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/radio-group/radio-group.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsRadioGroup", "declaration": { "name": "GdsRadioGroup", "module": "src/components/radio/radio-group/radio-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/date/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/sensitive/date/sensitive-date" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/date/sensitive-date.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsSensitiveDate", "members": [ { "kind": "field", "name": "hide", "type": { "text": "boolean" }, "default": "false", "description": "When true, hides the sensitive date.", "attribute": "hide" }, { "kind": "field", "name": "value", "type": { "text": "Date | string | undefined" }, "description": "The date value to be formatted, either Date or ISO string.", "inheritedFrom": { "name": "GdsFormattedDate", "module": "src/components/formatted-text/date/formatted-date.component.ts" } }, { "kind": "field", "name": "format", "type": { "text": "DateTimeFormat" }, "default": "'dateOnlyNumbers'", "description": "Specifies the date format.", "attribute": "format", "inheritedFrom": { "name": "GdsFormattedDate", "module": "src/components/formatted-text/date/formatted-date.component.ts" } }, { "kind": "field", "name": "locale", "type": { "text": "string | undefined" }, "description": "The locale used for date formatting.", "attribute": "locale", "inheritedFrom": { "name": "GdsFormattedDate", "module": "src/components/formatted-text/date/formatted-date.component.ts" } }, { "kind": "field", "name": "formattedValue", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "GdsFormattedText", "module": "src/components/formatted-text/formatted-text.ts" } }, { "kind": "field", "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "attribute": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-transform'", "type": { "text": "string | undefined" }, "description": "Controls the text-transform property of the text.\nSupports all valid CSS text-transform values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'text-decoration'", "type": { "text": "string | undefined" }, "description": "Controls the text-decoration property of the inner element.\nSupports all valid CSS text-decoration values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "lines", "type": { "text": "number | undefined" }, "description": "Controls the number of lines it should show.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "hide", "type": { "text": "boolean" }, "default": "false", "description": "When true, hides the sensitive date.", "fieldName": "hide" }, { "name": "format", "type": { "text": "DateTimeFormat" }, "default": "'dateOnlyNumbers'", "description": "Specifies the date format.", "fieldName": "format", "inheritedFrom": { "name": "GdsFormattedDate", "module": "src/components/formatted-text/date/formatted-date.component.ts" } }, { "name": "locale", "type": { "text": "string | undefined" }, "description": "The locale used for date formatting.", "fieldName": "locale", "inheritedFrom": { "name": "GdsFormattedDate", "module": "src/components/formatted-text/date/formatted-date.component.ts" } }, { "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "fieldName": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsFormattedDate", "module": "/src/components/formatted-text/date/formatted-date.component" }, "tagName": "gds-sensitive-date", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSensitiveDate", "declaration": { "name": "GdsSensitiveDate", "module": "src/components/sensitive/date/sensitive-date.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/date/sensitive-date.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Sensitive/Date', component: 'gds-sensitive-date', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-sensitive-date'), format: { control: { type: 'select' }, options: Object.keys(dateTimeFormats), }, }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/sensitive/date)\n\nGdsSensitiveDate displays a formatted date and optionally hides it using a blur effect\nwhen the 'hide' property is set to true." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html``, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/sensitive/date/sensitive-date.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/sensitive/date/sensitive-date.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/date/sensitive-date.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsSensitiveDate", "declaration": { "name": "GdsSensitiveDate", "module": "src/components/sensitive/date/sensitive-date.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/number/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/sensitive/number/sensitive-number" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/number/sensitive-number.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "GdsSensitiveNumber", "members": [ { "kind": "field", "name": "hide", "type": { "text": "boolean" }, "default": "false", "description": "When true, hides the sensitive number.", "attribute": "hide" }, { "kind": "field", "name": "formattedValue", "type": { "text": "string" }, "readonly": true, "inheritedFrom": { "name": "GdsFormattedText", "module": "src/components/formatted-text/formatted-text.ts" } }, { "kind": "field", "name": "value", "type": { "text": "number | string | undefined" }, "description": "The numerical value to display.", "inheritedFrom": { "name": "GdsFormattedNumber", "module": "src/components/formatted-text/number/formatted-number.component.ts" } }, { "kind": "field", "name": "locale", "type": { "text": "string | undefined" }, "description": "The locale used for number formatting.", "attribute": "locale", "inheritedFrom": { "name": "GdsFormattedNumber", "module": "src/components/formatted-text/number/formatted-number.component.ts" } }, { "kind": "field", "name": "currency", "type": { "text": "string | undefined" }, "description": "The currency used when formatting numbers.", "attribute": "currency", "inheritedFrom": { "name": "GdsFormattedNumber", "module": "src/components/formatted-text/number/formatted-number.component.ts" } }, { "kind": "field", "name": "decimals", "type": { "text": "number | undefined" }, "description": "The number of decimal places to display.", "attribute": "decimals", "inheritedFrom": { "name": "GdsFormattedNumber", "module": "src/components/formatted-text/number/formatted-number.component.ts" } }, { "kind": "field", "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "attribute": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'font'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font` property.\nSupports all font tokens from the design system.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'font-weight'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `font-weight` property.\nSupports all typography weight tokens from the design system.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-transform'", "type": { "text": "string | undefined" }, "description": "Controls the text-transform property of the text.\nSupports all valid CSS text-transform values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "'text-decoration'", "type": { "text": "string | undefined" }, "description": "Controls the text-decoration property of the inner element.\nSupports all valid CSS text-decoration values.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "lines", "type": { "text": "number | undefined" }, "description": "Controls the number of lines it should show.", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "kind": "field", "name": "width", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `width` property.\nSupports space tokens and all valid CSS `width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-width` property.\nSupports space tokens and all valid CSS `min-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-width` property.\nSupports space tokens and all valid CSS `max-width` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inline-size` property.\nSupports space tokens and all valid CSS `inline-size` values", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-inline-size` property.\nSupports space tokens and all valid CSS `min-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-inline-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-inline-size` property.\nSupports space tokens and all valid CSS `max-inline-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeXProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "height", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `height` property.\nSupports space tokens and all valid CSS `height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-height` property.\nSupports space tokens and all valid CSS `min-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-height'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-height` property.\nSupports space tokens and all valid CSS `max-height` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `block-size` property.\nSupports space tokens and all valid CSS `block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'min-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `min-block-size` property.\nSupports space tokens and all valid CSS `min-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'max-block-size'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `max-block-size` property.\nSupports space tokens and all valid CSS `max-block-size` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withSizeYProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "padding", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'padding-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `padding-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPaddingProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "position", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `position` property.\nSupports all valid CSS `position` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "transform", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `transform` property.\nSupports all valid CSS `transform` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "inset", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `inset` property.\nSupports all valid CSS `inset` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withPositioningProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "display", "type": { "text": "string | undefined" }, "description": "Controls the display property.\nSupports all valid CSS display values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "background", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `background` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "border", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border` property.\nAccepts a string of the same format as the CSS border property.\n\n```html\n\n```\n\nWhere the size value accepts space tokens and the color value accepts color tokens and an optional transparency value.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-color'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-width'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-width` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-style'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-style` property.\nSupports all valid CSS `border-style` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'border-radius'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `border-radius` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-shadow'", "type": { "text": "string | undefined" }, "description": "Style Expression Property for the `box-shadow` property.\n\nAccepts shadow tokens from the design system.\n\n`xs`, `s`, `m`, `l`, `xl`", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "opacity", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `opacity` property.\nSupports all valid CSS `opacity` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "overflow", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow` property.\nSupports all valid CSS `overflow` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'box-sizing'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `box-sizing` property.\nSupports all valid CSS `box-sizing` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'z-index'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `z-index` property.\nSupports all valid CSS `z-index` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-align'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-align` property.\nSupports all valid CSS `text-align` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'text-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `text-wrap` property.\nSupports all valid CSS `text-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'overflow-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `overflow-wrap` property.\nSupports all valid CSS `overflow-wrap` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'white-space'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `white-space` property.\nSupports all valid CSS `white-space` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "gap", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `gap` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-items` property.\nSupports all valid CSS `align-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'align-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-content` property.\nSupports all valid CSS `align-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-content` property.\nSupports all valid CSS `justify-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'justify-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-items` property.\nSupports all valid CSS `justify-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-direction'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-direction` property.\nSupports all valid CSS `flex-direction` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'flex-wrap'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex-wrap` property.\nSupports all valid CSS `flex-wrap` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-items'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-items` property.\nSupports all valid CSS `place-items` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'place-content'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-content` property.\nSupports all valid CSS `place-content` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'aspect-ratio'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `aspect-ratio` property.\nSupports all valid CSS `aspect-ratio` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "cursor", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `cursor` property.\nSupports all valid CSS `cursor` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "field", "name": "'pointer-events'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `pointer-events` property.\nSupports all valid CSS `pointer-events` values.", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "attributes": [ { "name": "hide", "type": { "text": "boolean" }, "default": "false", "description": "When true, hides the sensitive number.", "fieldName": "hide" }, { "name": "locale", "type": { "text": "string | undefined" }, "description": "The locale used for number formatting.", "fieldName": "locale", "inheritedFrom": { "name": "GdsFormattedNumber", "module": "src/components/formatted-text/number/formatted-number.component.ts" } }, { "name": "currency", "type": { "text": "string | undefined" }, "description": "The currency used when formatting numbers.", "fieldName": "currency", "inheritedFrom": { "name": "GdsFormattedNumber", "module": "src/components/formatted-text/number/formatted-number.component.ts" } }, { "name": "decimals", "type": { "text": "number | undefined" }, "description": "The number of decimal places to display.", "fieldName": "decimals", "inheritedFrom": { "name": "GdsFormattedNumber", "module": "src/components/formatted-text/number/formatted-number.component.ts" } }, { "name": "format", "type": { "text": "NumberFormats" }, "default": "'decimalsAndThousands'", "description": "Specifies the number format.", "fieldName": "format", "inheritedFrom": { "name": "GdsFormattedNumber", "module": "src/components/formatted-text/number/formatted-number.component.ts" } }, { "name": "tag", "type": { "text": "string" }, "default": "'span'", "description": "Controls the tag of the text.\nSupports all valid HTML tags like h1, h2, h3, h4, h5, h6, p, span, etc.", "fieldName": "tag", "inheritedFrom": { "name": "GdsText", "module": "src/components/text/text.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the container is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-div` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsDiv", "module": "src/components/div/div.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "superclass": { "name": "GdsFormattedNumber", "module": "/src/components/formatted-text/number/formatted-number.component" }, "tagName": "gds-sensitive-number", "customElement": true, "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "GdsSensitiveNumber", "declaration": { "name": "GdsSensitiveNumber", "module": "src/components/sensitive/number/sensitive-number.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/number/sensitive-number.stories.ts", "declarations": [ { "kind": "variable", "name": "meta", "type": { "text": "Meta" }, "default": "{ title: 'Components/Sensitive/Number', component: 'gds-sensitive-number', tags: ['autodocs'], argTypes: { ...argTablePropsFor('gds-sensitive-number'), format: { control: { type: 'select' }, options: Object.keys(numberFormats), }, currency: { type: 'string', }, decimals: { type: 'number', }, }, }", "description": "[Source code](https://github.com/seb-oss/green/tree/main/libs/core/src/components/sensitive/number)\n\nGdsSensitiveNumber displays a formatted number and optionally hides it using a blur effect\nwhen the 'hide' property is set to true." }, { "kind": "variable", "name": "Default", "type": { "text": "Story" }, "default": "{ ...DefaultParams, render: (args) => html``, }" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "meta", "module": "src/components/sensitive/number/sensitive-number.stories.ts" } }, { "kind": "js", "name": "Default", "declaration": { "name": "Default", "module": "src/components/sensitive/number/sensitive-number.stories.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/sensitive/number/sensitive-number.ts", "declarations": [], "exports": [ { "kind": "js", "name": "GdsSensitiveNumber", "declaration": { "name": "GdsSensitiveNumber", "module": "src/components/sensitive/number/sensitive-number.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/ai.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconAi", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-ai", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconAi", "declaration": { "name": "IconAi", "module": "src/components/icon/icons/ai.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/ai.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconAi", "declaration": { "name": "IconAi", "module": "src/components/icon/icons/ai.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/airplane-up.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconAirplaneUp", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-airplane-up", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconAirplaneUp", "declaration": { "name": "IconAirplaneUp", "module": "src/components/icon/icons/airplane-up.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/airplane-up.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconAirplaneUp", "declaration": { "name": "IconAirplaneUp", "module": "src/components/icon/icons/airplane-up.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/archive.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArchive", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-archive", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArchive", "declaration": { "name": "IconArchive", "module": "src/components/icon/icons/archive.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/archive.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArchive", "declaration": { "name": "IconArchive", "module": "src/components/icon/icons/archive.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-bottom-top.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowBottomTop", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-bottom-top", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowBottomTop", "declaration": { "name": "IconArrowBottomTop", "module": "src/components/icon/icons/arrow-bottom-top.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-bottom-top.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowBottomTop", "declaration": { "name": "IconArrowBottomTop", "module": "src/components/icon/icons/arrow-bottom-top.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-box-left-alt.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowBoxLeftAlt", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-box-left-alt", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowBoxLeftAlt", "declaration": { "name": "IconArrowBoxLeftAlt", "module": "src/components/icon/icons/arrow-box-left-alt.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-box-left-alt.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowBoxLeftAlt", "declaration": { "name": "IconArrowBoxLeftAlt", "module": "src/components/icon/icons/arrow-box-left-alt.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-box-left.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowBoxLeft", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-box-left", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowBoxLeft", "declaration": { "name": "IconArrowBoxLeft", "module": "src/components/icon/icons/arrow-box-left.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-box-left.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowBoxLeft", "declaration": { "name": "IconArrowBoxLeft", "module": "src/components/icon/icons/arrow-box-left.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-box-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowBoxRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-box-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowBoxRight", "declaration": { "name": "IconArrowBoxRight", "module": "src/components/icon/icons/arrow-box-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-box-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowBoxRight", "declaration": { "name": "IconArrowBoxRight", "module": "src/components/icon/icons/arrow-box-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-down.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowDown", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-down", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowDown", "declaration": { "name": "IconArrowDown", "module": "src/components/icon/icons/arrow-down.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-down.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowDown", "declaration": { "name": "IconArrowDown", "module": "src/components/icon/icons/arrow-down.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-inbox.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowInbox", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-inbox", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowInbox", "declaration": { "name": "IconArrowInbox", "module": "src/components/icon/icons/arrow-inbox.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-inbox.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowInbox", "declaration": { "name": "IconArrowInbox", "module": "src/components/icon/icons/arrow-inbox.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-left-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowLeftRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-left-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowLeftRight", "declaration": { "name": "IconArrowLeftRight", "module": "src/components/icon/icons/arrow-left-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-left-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowLeftRight", "declaration": { "name": "IconArrowLeftRight", "module": "src/components/icon/icons/arrow-left-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-left.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowLeft", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-left", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowLeft", "declaration": { "name": "IconArrowLeft", "module": "src/components/icon/icons/arrow-left.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-left.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowLeft", "declaration": { "name": "IconArrowLeft", "module": "src/components/icon/icons/arrow-left.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-out-of-box.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowOutOfBox", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-out-of-box", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowOutOfBox", "declaration": { "name": "IconArrowOutOfBox", "module": "src/components/icon/icons/arrow-out-of-box.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-out-of-box.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowOutOfBox", "declaration": { "name": "IconArrowOutOfBox", "module": "src/components/icon/icons/arrow-out-of-box.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-right-circle.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowRightCircle", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-right-circle", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRightCircle", "declaration": { "name": "IconArrowRightCircle", "module": "src/components/icon/icons/arrow-right-circle.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-right-circle.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowRightCircle", "declaration": { "name": "IconArrowRightCircle", "module": "src/components/icon/icons/arrow-right-circle.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-right-down-circle.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowRightDownCircle", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-right-down-circle", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRightDownCircle", "declaration": { "name": "IconArrowRightDownCircle", "module": "src/components/icon/icons/arrow-right-down-circle.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-right-down-circle.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowRightDownCircle", "declaration": { "name": "IconArrowRightDownCircle", "module": "src/components/icon/icons/arrow-right-down-circle.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-right-up-circle.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowRightUpCircle", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-right-up-circle", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRightUpCircle", "declaration": { "name": "IconArrowRightUpCircle", "module": "src/components/icon/icons/arrow-right-up-circle.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-right-up-circle.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowRightUpCircle", "declaration": { "name": "IconArrowRightUpCircle", "module": "src/components/icon/icons/arrow-right-up-circle.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRight", "declaration": { "name": "IconArrowRight", "module": "src/components/icon/icons/arrow-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowRight", "declaration": { "name": "IconArrowRight", "module": "src/components/icon/icons/arrow-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-rotate-clockwise.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowRotateClockwise", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-rotate-clockwise", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRotateClockwise", "declaration": { "name": "IconArrowRotateClockwise", "module": "src/components/icon/icons/arrow-rotate-clockwise.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-rotate-clockwise.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowRotateClockwise", "declaration": { "name": "IconArrowRotateClockwise", "module": "src/components/icon/icons/arrow-rotate-clockwise.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-rotate-counter-clockwise.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowRotateCounterClockwise", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-rotate-counter-clockwise", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRotateCounterClockwise", "declaration": { "name": "IconArrowRotateCounterClockwise", "module": "src/components/icon/icons/arrow-rotate-counter-clockwise.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-rotate-counter-clockwise.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowRotateCounterClockwise", "declaration": { "name": "IconArrowRotateCounterClockwise", "module": "src/components/icon/icons/arrow-rotate-counter-clockwise.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-rotate-left-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowRotateLeftRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-rotate-left-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRotateLeftRight", "declaration": { "name": "IconArrowRotateLeftRight", "module": "src/components/icon/icons/arrow-rotate-left-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-rotate-left-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowRotateLeftRight", "declaration": { "name": "IconArrowRotateLeftRight", "module": "src/components/icon/icons/arrow-rotate-left-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-rotate-right-left.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowRotateRightLeft", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-rotate-right-left", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRotateRightLeft", "declaration": { "name": "IconArrowRotateRightLeft", "module": "src/components/icon/icons/arrow-rotate-right-left.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-rotate-right-left.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowRotateRightLeft", "declaration": { "name": "IconArrowRotateRightLeft", "module": "src/components/icon/icons/arrow-rotate-right-left.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-share-left.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowShareLeft", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-share-left", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowShareLeft", "declaration": { "name": "IconArrowShareLeft", "module": "src/components/icon/icons/arrow-share-left.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-share-left.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowShareLeft", "declaration": { "name": "IconArrowShareLeft", "module": "src/components/icon/icons/arrow-share-left.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-share-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowShareRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-share-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowShareRight", "declaration": { "name": "IconArrowShareRight", "module": "src/components/icon/icons/arrow-share-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-share-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowShareRight", "declaration": { "name": "IconArrowShareRight", "module": "src/components/icon/icons/arrow-share-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-split.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowSplit", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-split", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowSplit", "declaration": { "name": "IconArrowSplit", "module": "src/components/icon/icons/arrow-split.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-split.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowSplit", "declaration": { "name": "IconArrowSplit", "module": "src/components/icon/icons/arrow-split.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-up.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowUp", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-up", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowUp", "declaration": { "name": "IconArrowUp", "module": "src/components/icon/icons/arrow-up.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-up.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowUp", "declaration": { "name": "IconArrowUp", "module": "src/components/icon/icons/arrow-up.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-wall-down.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowWallDown", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-wall-down", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowWallDown", "declaration": { "name": "IconArrowWallDown", "module": "src/components/icon/icons/arrow-wall-down.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-wall-down.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowWallDown", "declaration": { "name": "IconArrowWallDown", "module": "src/components/icon/icons/arrow-wall-down.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-wall-left.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowWallLeft", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-wall-left", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowWallLeft", "declaration": { "name": "IconArrowWallLeft", "module": "src/components/icon/icons/arrow-wall-left.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-wall-left.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowWallLeft", "declaration": { "name": "IconArrowWallLeft", "module": "src/components/icon/icons/arrow-wall-left.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-wall-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowWallRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-wall-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowWallRight", "declaration": { "name": "IconArrowWallRight", "module": "src/components/icon/icons/arrow-wall-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-wall-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowWallRight", "declaration": { "name": "IconArrowWallRight", "module": "src/components/icon/icons/arrow-wall-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-wall-up.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrowWallUp", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow-wall-up", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowWallUp", "declaration": { "name": "IconArrowWallUp", "module": "src/components/icon/icons/arrow-wall-up.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow-wall-up.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrowWallUp", "declaration": { "name": "IconArrowWallUp", "module": "src/components/icon/icons/arrow-wall-up.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconArrow", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-arrow", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrow", "declaration": { "name": "IconArrow", "module": "src/components/icon/icons/arrow.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/arrow.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconArrow", "declaration": { "name": "IconArrow", "module": "src/components/icon/icons/arrow.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/asterisk.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconAsterisk", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-asterisk", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconAsterisk", "declaration": { "name": "IconAsterisk", "module": "src/components/icon/icons/asterisk.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/asterisk.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconAsterisk", "declaration": { "name": "IconAsterisk", "module": "src/components/icon/icons/asterisk.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/at.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconAt", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-at", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconAt", "declaration": { "name": "IconAt", "module": "src/components/icon/icons/at.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/at.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconAt", "declaration": { "name": "IconAt", "module": "src/components/icon/icons/at.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/back.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBack", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-back", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBack", "declaration": { "name": "IconBack", "module": "src/components/icon/icons/back.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/back.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBack", "declaration": { "name": "IconBack", "module": "src/components/icon/icons/back.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/backward.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBackward", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-backward", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBackward", "declaration": { "name": "IconBackward", "module": "src/components/icon/icons/backward.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/backward.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBackward", "declaration": { "name": "IconBackward", "module": "src/components/icon/icons/backward.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bag.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBag", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bag", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBag", "declaration": { "name": "IconBag", "module": "src/components/icon/icons/bag.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bag.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBag", "declaration": { "name": "IconBag", "module": "src/components/icon/icons/bag.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bank.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBank", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bank", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBank", "declaration": { "name": "IconBank", "module": "src/components/icon/icons/bank.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bank.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBank", "declaration": { "name": "IconBank", "module": "src/components/icon/icons/bank.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/banknote-2.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBanknote2", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-banknote-2", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBanknote2", "declaration": { "name": "IconBanknote2", "module": "src/components/icon/icons/banknote-2.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/banknote-2.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBanknote2", "declaration": { "name": "IconBanknote2", "module": "src/components/icon/icons/banknote-2.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/banknote.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBanknote", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-banknote", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBanknote", "declaration": { "name": "IconBanknote", "module": "src/components/icon/icons/banknote.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/banknote.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBanknote", "declaration": { "name": "IconBanknote", "module": "src/components/icon/icons/banknote.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/barcode.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBarcode", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-barcode", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBarcode", "declaration": { "name": "IconBarcode", "module": "src/components/icon/icons/barcode.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/barcode.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBarcode", "declaration": { "name": "IconBarcode", "module": "src/components/icon/icons/barcode.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bars-three.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBarsThree", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bars-three", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBarsThree", "declaration": { "name": "IconBarsThree", "module": "src/components/icon/icons/bars-three.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bars-three.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBarsThree", "declaration": { "name": "IconBarsThree", "module": "src/components/icon/icons/bars-three.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bars-two.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBarsTwo", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bars-two", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBarsTwo", "declaration": { "name": "IconBarsTwo", "module": "src/components/icon/icons/bars-two.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bars-two.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBarsTwo", "declaration": { "name": "IconBarsTwo", "module": "src/components/icon/icons/bars-two.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/basket.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBasket", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-basket", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBasket", "declaration": { "name": "IconBasket", "module": "src/components/icon/icons/basket.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/basket.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBasket", "declaration": { "name": "IconBasket", "module": "src/components/icon/icons/basket.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/battery-loading.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBatteryLoading", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-battery-loading", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBatteryLoading", "declaration": { "name": "IconBatteryLoading", "module": "src/components/icon/icons/battery-loading.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/battery-loading.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBatteryLoading", "declaration": { "name": "IconBatteryLoading", "module": "src/components/icon/icons/battery-loading.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bell.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBell", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bell", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBell", "declaration": { "name": "IconBell", "module": "src/components/icon/icons/bell.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bell.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBell", "declaration": { "name": "IconBell", "module": "src/components/icon/icons/bell.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/block.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBlock", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-block", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBlock", "declaration": { "name": "IconBlock", "module": "src/components/icon/icons/block.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/block.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBlock", "declaration": { "name": "IconBlock", "module": "src/components/icon/icons/block.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/book.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBook", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-book", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBook", "declaration": { "name": "IconBook", "module": "src/components/icon/icons/book.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/book.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBook", "declaration": { "name": "IconBook", "module": "src/components/icon/icons/book.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bookmark-check.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBookmarkCheck", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bookmark-check", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBookmarkCheck", "declaration": { "name": "IconBookmarkCheck", "module": "src/components/icon/icons/bookmark-check.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bookmark-check.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBookmarkCheck", "declaration": { "name": "IconBookmarkCheck", "module": "src/components/icon/icons/bookmark-check.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bookmark-delete.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBookmarkDelete", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bookmark-delete", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBookmarkDelete", "declaration": { "name": "IconBookmarkDelete", "module": "src/components/icon/icons/bookmark-delete.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bookmark-delete.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBookmarkDelete", "declaration": { "name": "IconBookmarkDelete", "module": "src/components/icon/icons/bookmark-delete.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bookmark-plus.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBookmarkPlus", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bookmark-plus", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBookmarkPlus", "declaration": { "name": "IconBookmarkPlus", "module": "src/components/icon/icons/bookmark-plus.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bookmark-plus.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBookmarkPlus", "declaration": { "name": "IconBookmarkPlus", "module": "src/components/icon/icons/bookmark-plus.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bookmark-remove.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBookmarkRemove", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bookmark-remove", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBookmarkRemove", "declaration": { "name": "IconBookmarkRemove", "module": "src/components/icon/icons/bookmark-remove.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bookmark-remove.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBookmarkRemove", "declaration": { "name": "IconBookmarkRemove", "module": "src/components/icon/icons/bookmark-remove.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bookmark.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBookmark", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bookmark", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBookmark", "declaration": { "name": "IconBookmark", "module": "src/components/icon/icons/bookmark.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bookmark.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBookmark", "declaration": { "name": "IconBookmark", "module": "src/components/icon/icons/bookmark.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/books.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBooks", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-books", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBooks", "declaration": { "name": "IconBooks", "module": "src/components/icon/icons/books.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/books.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBooks", "declaration": { "name": "IconBooks", "module": "src/components/icon/icons/books.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-app-store.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandAppStore", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-app-store", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandAppStore", "declaration": { "name": "IconBrandAppStore", "module": "src/components/icon/icons/brand-app-store.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-app-store.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandAppStore", "declaration": { "name": "IconBrandAppStore", "module": "src/components/icon/icons/brand-app-store.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-apple-music.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandAppleMusic", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-apple-music", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandAppleMusic", "declaration": { "name": "IconBrandAppleMusic", "module": "src/components/icon/icons/brand-apple-music.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-apple-music.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandAppleMusic", "declaration": { "name": "IconBrandAppleMusic", "module": "src/components/icon/icons/brand-apple-music.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-bankid.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandBankid", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-bankid", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandBankid", "declaration": { "name": "IconBrandBankid", "module": "src/components/icon/icons/brand-bankid.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-bankid.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandBankid", "declaration": { "name": "IconBrandBankid", "module": "src/components/icon/icons/brand-bankid.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-chrome.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandChrome", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-chrome", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandChrome", "declaration": { "name": "IconBrandChrome", "module": "src/components/icon/icons/brand-chrome.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-chrome.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandChrome", "declaration": { "name": "IconBrandChrome", "module": "src/components/icon/icons/brand-chrome.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-facebook.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandFacebook", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-facebook", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandFacebook", "declaration": { "name": "IconBrandFacebook", "module": "src/components/icon/icons/brand-facebook.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-facebook.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandFacebook", "declaration": { "name": "IconBrandFacebook", "module": "src/components/icon/icons/brand-facebook.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-figma.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandFigma", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-figma", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandFigma", "declaration": { "name": "IconBrandFigma", "module": "src/components/icon/icons/brand-figma.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-figma.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandFigma", "declaration": { "name": "IconBrandFigma", "module": "src/components/icon/icons/brand-figma.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-firefox.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandFirefox", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-firefox", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandFirefox", "declaration": { "name": "IconBrandFirefox", "module": "src/components/icon/icons/brand-firefox.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-firefox.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandFirefox", "declaration": { "name": "IconBrandFirefox", "module": "src/components/icon/icons/brand-firefox.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-github.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandGithub", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-github", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandGithub", "declaration": { "name": "IconBrandGithub", "module": "src/components/icon/icons/brand-github.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-github.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandGithub", "declaration": { "name": "IconBrandGithub", "module": "src/components/icon/icons/brand-github.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-green.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandGreen", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-green", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandGreen", "declaration": { "name": "IconBrandGreen", "module": "src/components/icon/icons/brand-green.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-green.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandGreen", "declaration": { "name": "IconBrandGreen", "module": "src/components/icon/icons/brand-green.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-instagram.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandInstagram", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-instagram", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandInstagram", "declaration": { "name": "IconBrandInstagram", "module": "src/components/icon/icons/brand-instagram.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-instagram.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandInstagram", "declaration": { "name": "IconBrandInstagram", "module": "src/components/icon/icons/brand-instagram.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-linkedin.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandLinkedin", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-linkedin", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandLinkedin", "declaration": { "name": "IconBrandLinkedin", "module": "src/components/icon/icons/brand-linkedin.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-linkedin.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandLinkedin", "declaration": { "name": "IconBrandLinkedin", "module": "src/components/icon/icons/brand-linkedin.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-play-store.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandPlayStore", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-play-store", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandPlayStore", "declaration": { "name": "IconBrandPlayStore", "module": "src/components/icon/icons/brand-play-store.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-play-store.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandPlayStore", "declaration": { "name": "IconBrandPlayStore", "module": "src/components/icon/icons/brand-play-store.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-rss-feed.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandRssFeed", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-rss-feed", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandRssFeed", "declaration": { "name": "IconBrandRssFeed", "module": "src/components/icon/icons/brand-rss-feed.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-rss-feed.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandRssFeed", "declaration": { "name": "IconBrandRssFeed", "module": "src/components/icon/icons/brand-rss-feed.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-seb.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandSeb", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-seb", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandSeb", "declaration": { "name": "IconBrandSeb", "module": "src/components/icon/icons/brand-seb.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-seb.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandSeb", "declaration": { "name": "IconBrandSeb", "module": "src/components/icon/icons/brand-seb.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-spotify.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandSpotify", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-spotify", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandSpotify", "declaration": { "name": "IconBrandSpotify", "module": "src/components/icon/icons/brand-spotify.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-spotify.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandSpotify", "declaration": { "name": "IconBrandSpotify", "module": "src/components/icon/icons/brand-spotify.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-storybook.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandStorybook", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-storybook", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandStorybook", "declaration": { "name": "IconBrandStorybook", "module": "src/components/icon/icons/brand-storybook.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-storybook.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandStorybook", "declaration": { "name": "IconBrandStorybook", "module": "src/components/icon/icons/brand-storybook.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-swish-word.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandSwishWord", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-swish-word", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandSwishWord", "declaration": { "name": "IconBrandSwishWord", "module": "src/components/icon/icons/brand-swish-word.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-swish-word.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandSwishWord", "declaration": { "name": "IconBrandSwishWord", "module": "src/components/icon/icons/brand-swish-word.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-x.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrandX", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brand-x", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandX", "declaration": { "name": "IconBrandX", "module": "src/components/icon/icons/brand-x.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brand-x.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrandX", "declaration": { "name": "IconBrandX", "module": "src/components/icon/icons/brand-x.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brush.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBrush", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-brush", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrush", "declaration": { "name": "IconBrush", "module": "src/components/icon/icons/brush.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/brush.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBrush", "declaration": { "name": "IconBrush", "module": "src/components/icon/icons/brush.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bubble-annotation.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBubbleAnnotation", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bubble-annotation", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBubbleAnnotation", "declaration": { "name": "IconBubbleAnnotation", "module": "src/components/icon/icons/bubble-annotation.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bubble-annotation.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBubbleAnnotation", "declaration": { "name": "IconBubbleAnnotation", "module": "src/components/icon/icons/bubble-annotation.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bubbles.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBubbles", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bubbles", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBubbles", "declaration": { "name": "IconBubbles", "module": "src/components/icon/icons/bubbles.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bubbles.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBubbles", "declaration": { "name": "IconBubbles", "module": "src/components/icon/icons/bubbles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/buildings.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBuildings", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-buildings", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBuildings", "declaration": { "name": "IconBuildings", "module": "src/components/icon/icons/buildings.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/buildings.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBuildings", "declaration": { "name": "IconBuildings", "module": "src/components/icon/icons/buildings.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bullet-list.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconBulletList", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-bullet-list", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconBulletList", "declaration": { "name": "IconBulletList", "module": "src/components/icon/icons/bullet-list.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/bullet-list.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconBulletList", "declaration": { "name": "IconBulletList", "module": "src/components/icon/icons/bullet-list.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/calculator.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCalculator", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-calculator", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCalculator", "declaration": { "name": "IconCalculator", "module": "src/components/icon/icons/calculator.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/calculator.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCalculator", "declaration": { "name": "IconCalculator", "module": "src/components/icon/icons/calculator.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/calendar-check.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCalendarCheck", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-calendar-check", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCalendarCheck", "declaration": { "name": "IconCalendarCheck", "module": "src/components/icon/icons/calendar-check.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/calendar-check.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCalendarCheck", "declaration": { "name": "IconCalendarCheck", "module": "src/components/icon/icons/calendar-check.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/calendar.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCalendar", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-calendar", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCalendar", "declaration": { "name": "IconCalendar", "module": "src/components/icon/icons/calendar.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/calendar.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCalendar", "declaration": { "name": "IconCalendar", "module": "src/components/icon/icons/calendar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/calender-add.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCalenderAdd", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-calender-add", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCalenderAdd", "declaration": { "name": "IconCalenderAdd", "module": "src/components/icon/icons/calender-add.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/calender-add.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCalenderAdd", "declaration": { "name": "IconCalenderAdd", "module": "src/components/icon/icons/calender-add.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/call.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCall", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-call", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCall", "declaration": { "name": "IconCall", "module": "src/components/icon/icons/call.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/call.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCall", "declaration": { "name": "IconCall", "module": "src/components/icon/icons/call.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/car.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCar", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-car", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCar", "declaration": { "name": "IconCar", "module": "src/components/icon/icons/car.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/car.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCar", "declaration": { "name": "IconCar", "module": "src/components/icon/icons/car.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/carussel.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCarussel", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-carussel", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCarussel", "declaration": { "name": "IconCarussel", "module": "src/components/icon/icons/carussel.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/carussel.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCarussel", "declaration": { "name": "IconCarussel", "module": "src/components/icon/icons/carussel.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chain-link-broken.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChainLinkBroken", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chain-link-broken", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChainLinkBroken", "declaration": { "name": "IconChainLinkBroken", "module": "src/components/icon/icons/chain-link-broken.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chain-link-broken.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChainLinkBroken", "declaration": { "name": "IconChainLinkBroken", "module": "src/components/icon/icons/chain-link-broken.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chain-link.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChainLink", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chain-link", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChainLink", "declaration": { "name": "IconChainLink", "module": "src/components/icon/icons/chain-link.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chain-link.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChainLink", "declaration": { "name": "IconChainLink", "module": "src/components/icon/icons/chain-link.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chart-two.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChartTwo", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chart-two", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChartTwo", "declaration": { "name": "IconChartTwo", "module": "src/components/icon/icons/chart-two.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chart-two.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChartTwo", "declaration": { "name": "IconChartTwo", "module": "src/components/icon/icons/chart-two.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/checklist.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChecklist", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-checklist", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChecklist", "declaration": { "name": "IconChecklist", "module": "src/components/icon/icons/checklist.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/checklist.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChecklist", "declaration": { "name": "IconChecklist", "module": "src/components/icon/icons/checklist.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/checkmark.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCheckmark", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-checkmark", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCheckmark", "declaration": { "name": "IconCheckmark", "module": "src/components/icon/icons/checkmark.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/checkmark.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCheckmark", "declaration": { "name": "IconCheckmark", "module": "src/components/icon/icons/checkmark.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-bottom.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronBottom", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-bottom", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronBottom", "declaration": { "name": "IconChevronBottom", "module": "src/components/icon/icons/chevron-bottom.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-bottom.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronBottom", "declaration": { "name": "IconChevronBottom", "module": "src/components/icon/icons/chevron-bottom.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-double-down.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronDoubleDown", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-double-down", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronDoubleDown", "declaration": { "name": "IconChevronDoubleDown", "module": "src/components/icon/icons/chevron-double-down.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-double-down.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronDoubleDown", "declaration": { "name": "IconChevronDoubleDown", "module": "src/components/icon/icons/chevron-double-down.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-double-left.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronDoubleLeft", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-double-left", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronDoubleLeft", "declaration": { "name": "IconChevronDoubleLeft", "module": "src/components/icon/icons/chevron-double-left.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-double-left.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronDoubleLeft", "declaration": { "name": "IconChevronDoubleLeft", "module": "src/components/icon/icons/chevron-double-left.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-double-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronDoubleRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-double-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronDoubleRight", "declaration": { "name": "IconChevronDoubleRight", "module": "src/components/icon/icons/chevron-double-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-double-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronDoubleRight", "declaration": { "name": "IconChevronDoubleRight", "module": "src/components/icon/icons/chevron-double-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-double-up.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronDoubleUp", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-double-up", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronDoubleUp", "declaration": { "name": "IconChevronDoubleUp", "module": "src/components/icon/icons/chevron-double-up.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-double-up.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronDoubleUp", "declaration": { "name": "IconChevronDoubleUp", "module": "src/components/icon/icons/chevron-double-up.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-down-small.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronDownSmall", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-down-small", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronDownSmall", "declaration": { "name": "IconChevronDownSmall", "module": "src/components/icon/icons/chevron-down-small.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-down-small.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronDownSmall", "declaration": { "name": "IconChevronDownSmall", "module": "src/components/icon/icons/chevron-down-small.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-grabber-vertical-reversed.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronGrabberVerticalReversed", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-grabber-vertical-reversed", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronGrabberVerticalReversed", "declaration": { "name": "IconChevronGrabberVerticalReversed", "module": "src/components/icon/icons/chevron-grabber-vertical-reversed.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-grabber-vertical-reversed.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronGrabberVerticalReversed", "declaration": { "name": "IconChevronGrabberVerticalReversed", "module": "src/components/icon/icons/chevron-grabber-vertical-reversed.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-grabber-vertical.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronGrabberVertical", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-grabber-vertical", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronGrabberVertical", "declaration": { "name": "IconChevronGrabberVertical", "module": "src/components/icon/icons/chevron-grabber-vertical.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-grabber-vertical.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronGrabberVertical", "declaration": { "name": "IconChevronGrabberVertical", "module": "src/components/icon/icons/chevron-grabber-vertical.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-left-small.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronLeftSmall", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-left-small", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronLeftSmall", "declaration": { "name": "IconChevronLeftSmall", "module": "src/components/icon/icons/chevron-left-small.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-left-small.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronLeftSmall", "declaration": { "name": "IconChevronLeftSmall", "module": "src/components/icon/icons/chevron-left-small.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-left.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronLeft", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-left", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronLeft", "declaration": { "name": "IconChevronLeft", "module": "src/components/icon/icons/chevron-left.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-left.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronLeft", "declaration": { "name": "IconChevronLeft", "module": "src/components/icon/icons/chevron-left.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-right-small.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronRightSmall", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-right-small", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronRightSmall", "declaration": { "name": "IconChevronRightSmall", "module": "src/components/icon/icons/chevron-right-small.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-right-small.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronRightSmall", "declaration": { "name": "IconChevronRightSmall", "module": "src/components/icon/icons/chevron-right-small.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronRight", "declaration": { "name": "IconChevronRight", "module": "src/components/icon/icons/chevron-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronRight", "declaration": { "name": "IconChevronRight", "module": "src/components/icon/icons/chevron-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-top-small.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronTopSmall", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-top-small", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronTopSmall", "declaration": { "name": "IconChevronTopSmall", "module": "src/components/icon/icons/chevron-top-small.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-top-small.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronTopSmall", "declaration": { "name": "IconChevronTopSmall", "module": "src/components/icon/icons/chevron-top-small.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-top.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconChevronTop", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-chevron-top", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronTop", "declaration": { "name": "IconChevronTop", "module": "src/components/icon/icons/chevron-top.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/chevron-top.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconChevronTop", "declaration": { "name": "IconChevronTop", "module": "src/components/icon/icons/chevron-top.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-ban.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCircleBan", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-circle-ban", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleBan", "declaration": { "name": "IconCircleBan", "module": "src/components/icon/icons/circle-ban.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-ban.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCircleBan", "declaration": { "name": "IconCircleBan", "module": "src/components/icon/icons/circle-ban.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-check.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCircleCheck", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-circle-check", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleCheck", "declaration": { "name": "IconCircleCheck", "module": "src/components/icon/icons/circle-check.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-check.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCircleCheck", "declaration": { "name": "IconCircleCheck", "module": "src/components/icon/icons/circle-check.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-dots.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCircleDots", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-circle-dots", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleDots", "declaration": { "name": "IconCircleDots", "module": "src/components/icon/icons/circle-dots.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-dots.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCircleDots", "declaration": { "name": "IconCircleDots", "module": "src/components/icon/icons/circle-dots.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-info.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCircleInfo", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-circle-info", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleInfo", "declaration": { "name": "IconCircleInfo", "module": "src/components/icon/icons/circle-info.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-info.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCircleInfo", "declaration": { "name": "IconCircleInfo", "module": "src/components/icon/icons/circle-info.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-minus.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCircleMinus", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-circle-minus", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleMinus", "declaration": { "name": "IconCircleMinus", "module": "src/components/icon/icons/circle-minus.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-minus.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCircleMinus", "declaration": { "name": "IconCircleMinus", "module": "src/components/icon/icons/circle-minus.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-placeholder-on.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCirclePlaceholderOn", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-circle-placeholder-on", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCirclePlaceholderOn", "declaration": { "name": "IconCirclePlaceholderOn", "module": "src/components/icon/icons/circle-placeholder-on.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-placeholder-on.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCirclePlaceholderOn", "declaration": { "name": "IconCirclePlaceholderOn", "module": "src/components/icon/icons/circle-placeholder-on.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-plus.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCirclePlus", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-circle-plus", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCirclePlus", "declaration": { "name": "IconCirclePlus", "module": "src/components/icon/icons/circle-plus.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-plus.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCirclePlus", "declaration": { "name": "IconCirclePlus", "module": "src/components/icon/icons/circle-plus.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-questionmark.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCircleQuestionmark", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-circle-questionmark", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleQuestionmark", "declaration": { "name": "IconCircleQuestionmark", "module": "src/components/icon/icons/circle-questionmark.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-questionmark.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCircleQuestionmark", "declaration": { "name": "IconCircleQuestionmark", "module": "src/components/icon/icons/circle-questionmark.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-x.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCircleX", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-circle-x", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleX", "declaration": { "name": "IconCircleX", "module": "src/components/icon/icons/circle-x.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circle-x.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCircleX", "declaration": { "name": "IconCircleX", "module": "src/components/icon/icons/circle-x.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circles-three.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCirclesThree", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-circles-three", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCirclesThree", "declaration": { "name": "IconCirclesThree", "module": "src/components/icon/icons/circles-three.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/circles-three.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCirclesThree", "declaration": { "name": "IconCirclesThree", "module": "src/components/icon/icons/circles-three.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/clock.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconClock", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-clock", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconClock", "declaration": { "name": "IconClock", "module": "src/components/icon/icons/clock.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/clock.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconClock", "declaration": { "name": "IconClock", "module": "src/components/icon/icons/clock.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cloud-download.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCloudDownload", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-cloud-download", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCloudDownload", "declaration": { "name": "IconCloudDownload", "module": "src/components/icon/icons/cloud-download.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cloud-download.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCloudDownload", "declaration": { "name": "IconCloudDownload", "module": "src/components/icon/icons/cloud-download.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cloud-upload.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCloudUpload", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-cloud-upload", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCloudUpload", "declaration": { "name": "IconCloudUpload", "module": "src/components/icon/icons/cloud-upload.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cloud-upload.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCloudUpload", "declaration": { "name": "IconCloudUpload", "module": "src/components/icon/icons/cloud-upload.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cloudy-sun.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCloudySun", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-cloudy-sun", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCloudySun", "declaration": { "name": "IconCloudySun", "module": "src/components/icon/icons/cloudy-sun.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cloudy-sun.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCloudySun", "declaration": { "name": "IconCloudySun", "module": "src/components/icon/icons/cloudy-sun.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/code-brackets.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCodeBrackets", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-code-brackets", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCodeBrackets", "declaration": { "name": "IconCodeBrackets", "module": "src/components/icon/icons/code-brackets.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/code-brackets.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCodeBrackets", "declaration": { "name": "IconCodeBrackets", "module": "src/components/icon/icons/code-brackets.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/code.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCode", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-code", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCode", "declaration": { "name": "IconCode", "module": "src/components/icon/icons/code.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/code.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCode", "declaration": { "name": "IconCode", "module": "src/components/icon/icons/code.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/compass-round.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCompassRound", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-compass-round", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCompassRound", "declaration": { "name": "IconCompassRound", "module": "src/components/icon/icons/compass-round.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/compass-round.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCompassRound", "declaration": { "name": "IconCompassRound", "module": "src/components/icon/icons/compass-round.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cookies.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCookies", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-cookies", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCookies", "declaration": { "name": "IconCookies", "module": "src/components/icon/icons/cookies.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cookies.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCookies", "declaration": { "name": "IconCookies", "module": "src/components/icon/icons/cookies.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/copy.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCopy", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-copy", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCopy", "declaration": { "name": "IconCopy", "module": "src/components/icon/icons/copy.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/copy.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCopy", "declaration": { "name": "IconCopy", "module": "src/components/icon/icons/copy.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/credit-card-add.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCreditCardAdd", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-credit-card-add", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCreditCardAdd", "declaration": { "name": "IconCreditCardAdd", "module": "src/components/icon/icons/credit-card-add.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/credit-card-add.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCreditCardAdd", "declaration": { "name": "IconCreditCardAdd", "module": "src/components/icon/icons/credit-card-add.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/credit-card.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCreditCard", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-credit-card", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCreditCard", "declaration": { "name": "IconCreditCard", "module": "src/components/icon/icons/credit-card.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/credit-card.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCreditCard", "declaration": { "name": "IconCreditCard", "module": "src/components/icon/icons/credit-card.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cross-large.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCrossLarge", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-cross-large", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCrossLarge", "declaration": { "name": "IconCrossLarge", "module": "src/components/icon/icons/cross-large.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cross-large.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCrossLarge", "declaration": { "name": "IconCrossLarge", "module": "src/components/icon/icons/cross-large.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cross-small.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCrossSmall", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-cross-small", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCrossSmall", "declaration": { "name": "IconCrossSmall", "module": "src/components/icon/icons/cross-small.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cross-small.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCrossSmall", "declaration": { "name": "IconCrossSmall", "module": "src/components/icon/icons/cross-small.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cup-hot.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCupHot", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-cup-hot", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCupHot", "declaration": { "name": "IconCupHot", "module": "src/components/icon/icons/cup-hot.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cup-hot.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCupHot", "declaration": { "name": "IconCupHot", "module": "src/components/icon/icons/cup-hot.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cursor.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconCursor", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-cursor", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconCursor", "declaration": { "name": "IconCursor", "module": "src/components/icon/icons/cursor.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/cursor.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconCursor", "declaration": { "name": "IconCursor", "module": "src/components/icon/icons/cursor.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/devices.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconDevices", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-devices", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconDevices", "declaration": { "name": "IconDevices", "module": "src/components/icon/icons/devices.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/devices.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconDevices", "declaration": { "name": "IconDevices", "module": "src/components/icon/icons/devices.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/direction.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconDirection", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-direction", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconDirection", "declaration": { "name": "IconDirection", "module": "src/components/icon/icons/direction.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/direction.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconDirection", "declaration": { "name": "IconDirection", "module": "src/components/icon/icons/direction.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/dollar.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconDollar", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-dollar", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconDollar", "declaration": { "name": "IconDollar", "module": "src/components/icon/icons/dollar.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/dollar.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconDollar", "declaration": { "name": "IconDollar", "module": "src/components/icon/icons/dollar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/dot-grid-one-horizontal.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconDotGridOneHorizontal", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-dot-grid-one-horizontal", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconDotGridOneHorizontal", "declaration": { "name": "IconDotGridOneHorizontal", "module": "src/components/icon/icons/dot-grid-one-horizontal.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/dot-grid-one-horizontal.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconDotGridOneHorizontal", "declaration": { "name": "IconDotGridOneHorizontal", "module": "src/components/icon/icons/dot-grid-one-horizontal.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/dot-grid-one-vertical.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconDotGridOneVertical", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-dot-grid-one-vertical", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconDotGridOneVertical", "declaration": { "name": "IconDotGridOneVertical", "module": "src/components/icon/icons/dot-grid-one-vertical.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/dot-grid-one-vertical.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconDotGridOneVertical", "declaration": { "name": "IconDotGridOneVertical", "module": "src/components/icon/icons/dot-grid-one-vertical.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/dot-grid-three.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconDotGridThree", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-dot-grid-three", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconDotGridThree", "declaration": { "name": "IconDotGridThree", "module": "src/components/icon/icons/dot-grid-three.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/dot-grid-three.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconDotGridThree", "declaration": { "name": "IconDotGridThree", "module": "src/components/icon/icons/dot-grid-three.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/dot-grid-two.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconDotGridTwo", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-dot-grid-two", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconDotGridTwo", "declaration": { "name": "IconDotGridTwo", "module": "src/components/icon/icons/dot-grid-two.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/dot-grid-two.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconDotGridTwo", "declaration": { "name": "IconDotGridTwo", "module": "src/components/icon/icons/dot-grid-two.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/email.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconEmail", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-email", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmail", "declaration": { "name": "IconEmail", "module": "src/components/icon/icons/email.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/email.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconEmail", "declaration": { "name": "IconEmail", "module": "src/components/icon/icons/email.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/emoji-angry.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconEmojiAngry", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-emoji-angry", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmojiAngry", "declaration": { "name": "IconEmojiAngry", "module": "src/components/icon/icons/emoji-angry.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/emoji-angry.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconEmojiAngry", "declaration": { "name": "IconEmojiAngry", "module": "src/components/icon/icons/emoji-angry.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/emoji-neutral.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconEmojiNeutral", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-emoji-neutral", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmojiNeutral", "declaration": { "name": "IconEmojiNeutral", "module": "src/components/icon/icons/emoji-neutral.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/emoji-neutral.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconEmojiNeutral", "declaration": { "name": "IconEmojiNeutral", "module": "src/components/icon/icons/emoji-neutral.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/emoji-sad.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconEmojiSad", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-emoji-sad", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmojiSad", "declaration": { "name": "IconEmojiSad", "module": "src/components/icon/icons/emoji-sad.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/emoji-sad.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconEmojiSad", "declaration": { "name": "IconEmojiSad", "module": "src/components/icon/icons/emoji-sad.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/emoji-smile.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconEmojiSmile", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-emoji-smile", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmojiSmile", "declaration": { "name": "IconEmojiSmile", "module": "src/components/icon/icons/emoji-smile.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/emoji-smile.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconEmojiSmile", "declaration": { "name": "IconEmojiSmile", "module": "src/components/icon/icons/emoji-smile.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/emoji-smiley.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconEmojiSmiley", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-emoji-smiley", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmojiSmiley", "declaration": { "name": "IconEmojiSmiley", "module": "src/components/icon/icons/emoji-smiley.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/emoji-smiley.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconEmojiSmiley", "declaration": { "name": "IconEmojiSmiley", "module": "src/components/icon/icons/emoji-smiley.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/euro.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconEuro", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-euro", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconEuro", "declaration": { "name": "IconEuro", "module": "src/components/icon/icons/euro.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/euro.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconEuro", "declaration": { "name": "IconEuro", "module": "src/components/icon/icons/euro.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/expand.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconExpand", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-expand", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconExpand", "declaration": { "name": "IconExpand", "module": "src/components/icon/icons/expand.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/expand.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconExpand", "declaration": { "name": "IconExpand", "module": "src/components/icon/icons/expand.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/eye-open.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconEyeOpen", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-eye-open", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconEyeOpen", "declaration": { "name": "IconEyeOpen", "module": "src/components/icon/icons/eye-open.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/eye-open.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconEyeOpen", "declaration": { "name": "IconEyeOpen", "module": "src/components/icon/icons/eye-open.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/eye-slash.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconEyeSlash", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-eye-slash", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconEyeSlash", "declaration": { "name": "IconEyeSlash", "module": "src/components/icon/icons/eye-slash.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/eye-slash.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconEyeSlash", "declaration": { "name": "IconEyeSlash", "module": "src/components/icon/icons/eye-slash.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/fashion.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFashion", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-fashion", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFashion", "declaration": { "name": "IconFashion", "module": "src/components/icon/icons/fashion.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/fashion.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFashion", "declaration": { "name": "IconFashion", "module": "src/components/icon/icons/fashion.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/fast-forward.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFastForward", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-fast-forward", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFastForward", "declaration": { "name": "IconFastForward", "module": "src/components/icon/icons/fast-forward.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/fast-forward.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFastForward", "declaration": { "name": "IconFastForward", "module": "src/components/icon/icons/fast-forward.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/file-bend.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFileBend", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-file-bend", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFileBend", "declaration": { "name": "IconFileBend", "module": "src/components/icon/icons/file-bend.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/file-bend.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFileBend", "declaration": { "name": "IconFileBend", "module": "src/components/icon/icons/file-bend.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/file-chart.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFileChart", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-file-chart", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFileChart", "declaration": { "name": "IconFileChart", "module": "src/components/icon/icons/file-chart.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/file-chart.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFileChart", "declaration": { "name": "IconFileChart", "module": "src/components/icon/icons/file-chart.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/file-text.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFileText", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-file-text", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFileText", "declaration": { "name": "IconFileText", "module": "src/components/icon/icons/file-text.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/file-text.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFileText", "declaration": { "name": "IconFileText", "module": "src/components/icon/icons/file-text.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/files.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFiles", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-files", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFiles", "declaration": { "name": "IconFiles", "module": "src/components/icon/icons/files.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/files.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFiles", "declaration": { "name": "IconFiles", "module": "src/components/icon/icons/files.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/filter.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFilter", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-filter", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFilter", "declaration": { "name": "IconFilter", "module": "src/components/icon/icons/filter.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/filter.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFilter", "declaration": { "name": "IconFilter", "module": "src/components/icon/icons/filter.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/flag.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFlag", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-flag", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFlag", "declaration": { "name": "IconFlag", "module": "src/components/icon/icons/flag.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/flag.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFlag", "declaration": { "name": "IconFlag", "module": "src/components/icon/icons/flag.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/floppy-disk.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFloppyDisk", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-floppy-disk", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFloppyDisk", "declaration": { "name": "IconFloppyDisk", "module": "src/components/icon/icons/floppy-disk.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/floppy-disk.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFloppyDisk", "declaration": { "name": "IconFloppyDisk", "module": "src/components/icon/icons/floppy-disk.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/focus.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFocus", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-focus", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFocus", "declaration": { "name": "IconFocus", "module": "src/components/icon/icons/focus.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/focus.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFocus", "declaration": { "name": "IconFocus", "module": "src/components/icon/icons/focus.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/folder-add-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFolderAddRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-folder-add-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFolderAddRight", "declaration": { "name": "IconFolderAddRight", "module": "src/components/icon/icons/folder-add-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/folder-add-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFolderAddRight", "declaration": { "name": "IconFolderAddRight", "module": "src/components/icon/icons/folder-add-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/folder.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFolder", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-folder", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFolder", "declaration": { "name": "IconFolder", "module": "src/components/icon/icons/folder.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/folder.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFolder", "declaration": { "name": "IconFolder", "module": "src/components/icon/icons/folder.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/fullscreen.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconFullscreen", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-fullscreen", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconFullscreen", "declaration": { "name": "IconFullscreen", "module": "src/components/icon/icons/fullscreen.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/fullscreen.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconFullscreen", "declaration": { "name": "IconFullscreen", "module": "src/components/icon/icons/fullscreen.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/gift.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconGift", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-gift", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconGift", "declaration": { "name": "IconGift", "module": "src/components/icon/icons/gift.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/gift.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconGift", "declaration": { "name": "IconGift", "module": "src/components/icon/icons/gift.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/globus.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconGlobus", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-globus", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconGlobus", "declaration": { "name": "IconGlobus", "module": "src/components/icon/icons/globus.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/globus.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconGlobus", "declaration": { "name": "IconGlobus", "module": "src/components/icon/icons/globus.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/graduate-cap.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconGraduateCap", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-graduate-cap", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconGraduateCap", "declaration": { "name": "IconGraduateCap", "module": "src/components/icon/icons/graduate-cap.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/graduate-cap.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconGraduateCap", "declaration": { "name": "IconGraduateCap", "module": "src/components/icon/icons/graduate-cap.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/green-power.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconGreenPower", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-green-power", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconGreenPower", "declaration": { "name": "IconGreenPower", "module": "src/components/icon/icons/green-power.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/green-power.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconGreenPower", "declaration": { "name": "IconGreenPower", "module": "src/components/icon/icons/green-power.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/group.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconGroup", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-group", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconGroup", "declaration": { "name": "IconGroup", "module": "src/components/icon/icons/group.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/group.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconGroup", "declaration": { "name": "IconGroup", "module": "src/components/icon/icons/group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/growth.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconGrowth", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-growth", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconGrowth", "declaration": { "name": "IconGrowth", "module": "src/components/icon/icons/growth.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/growth.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconGrowth", "declaration": { "name": "IconGrowth", "module": "src/components/icon/icons/growth.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/headphones.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconHeadphones", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-headphones", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconHeadphones", "declaration": { "name": "IconHeadphones", "module": "src/components/icon/icons/headphones.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/headphones.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconHeadphones", "declaration": { "name": "IconHeadphones", "module": "src/components/icon/icons/headphones.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/heart-beat.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconHeartBeat", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-heart-beat", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconHeartBeat", "declaration": { "name": "IconHeartBeat", "module": "src/components/icon/icons/heart-beat.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/heart-beat.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconHeartBeat", "declaration": { "name": "IconHeartBeat", "module": "src/components/icon/icons/heart-beat.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/heart.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconHeart", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-heart", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconHeart", "declaration": { "name": "IconHeart", "module": "src/components/icon/icons/heart.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/heart.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconHeart", "declaration": { "name": "IconHeart", "module": "src/components/icon/icons/heart.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/history.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconHistory", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-history", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconHistory", "declaration": { "name": "IconHistory", "module": "src/components/icon/icons/history.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/history.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconHistory", "declaration": { "name": "IconHistory", "module": "src/components/icon/icons/history.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/home-energy-one.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconHomeEnergyOne", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-home-energy-one", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconHomeEnergyOne", "declaration": { "name": "IconHomeEnergyOne", "module": "src/components/icon/icons/home-energy-one.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/home-energy-one.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconHomeEnergyOne", "declaration": { "name": "IconHomeEnergyOne", "module": "src/components/icon/icons/home-energy-one.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/home-energy-two.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconHomeEnergyTwo", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-home-energy-two", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconHomeEnergyTwo", "declaration": { "name": "IconHomeEnergyTwo", "module": "src/components/icon/icons/home-energy-two.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/home-energy-two.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconHomeEnergyTwo", "declaration": { "name": "IconHomeEnergyTwo", "module": "src/components/icon/icons/home-energy-two.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/home-open.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconHomeOpen", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-home-open", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconHomeOpen", "declaration": { "name": "IconHomeOpen", "module": "src/components/icon/icons/home-open.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/home-open.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconHomeOpen", "declaration": { "name": "IconHomeOpen", "module": "src/components/icon/icons/home-open.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/home-roof.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconHomeRoof", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-home-roof", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconHomeRoof", "declaration": { "name": "IconHomeRoof", "module": "src/components/icon/icons/home-roof.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/home-roof.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconHomeRoof", "declaration": { "name": "IconHomeRoof", "module": "src/components/icon/icons/home-roof.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/horizontal-alignment-bottom.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconHorizontalAlignmentBottom", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-horizontal-alignment-bottom", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconHorizontalAlignmentBottom", "declaration": { "name": "IconHorizontalAlignmentBottom", "module": "src/components/icon/icons/horizontal-alignment-bottom.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/horizontal-alignment-bottom.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconHorizontalAlignmentBottom", "declaration": { "name": "IconHorizontalAlignmentBottom", "module": "src/components/icon/icons/horizontal-alignment-bottom.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/hourglass.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconHourglass", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-hourglass", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconHourglass", "declaration": { "name": "IconHourglass", "module": "src/components/icon/icons/hourglass.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/hourglass.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconHourglass", "declaration": { "name": "IconHourglass", "module": "src/components/icon/icons/hourglass.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/images.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconImages", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-images", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconImages", "declaration": { "name": "IconImages", "module": "src/components/icon/icons/images.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/images.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconImages", "declaration": { "name": "IconImages", "module": "src/components/icon/icons/images.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/inbox-empty.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconInboxEmpty", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-inbox-empty", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconInboxEmpty", "declaration": { "name": "IconInboxEmpty", "module": "src/components/icon/icons/inbox-empty.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/inbox-empty.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconInboxEmpty", "declaration": { "name": "IconInboxEmpty", "module": "src/components/icon/icons/inbox-empty.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/ai" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/airplane-up" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/archive" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-bottom-top" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-box-left-alt" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-box-left" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-box-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-down" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-inbox" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-left-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-left" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-out-of-box" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-right-circle" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-right-down-circle" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-right-up-circle" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-rotate-clockwise" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-rotate-counter-clockwise" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-rotate-left-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-rotate-right-left" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-share-left" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-share-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-split" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-up" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-wall-down" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-wall-left" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-wall-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-wall-up" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/asterisk" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/at" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/back" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/backward" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bag" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bank" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/banknote-2" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/banknote" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/barcode" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bars-three" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bars-two" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/basket" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/battery-loading" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bell" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/block" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/book" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bookmark-check" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bookmark-delete" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bookmark-plus" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bookmark-remove" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bookmark" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/books" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-app-store" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-apple-music" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-bankid" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-chrome" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-facebook" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-figma" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-firefox" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-github" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-green" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-instagram" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-linkedin" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-play-store" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-rss-feed" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-seb" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-spotify" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-storybook" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-swish-word" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-x" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brush" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bubble-annotation" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bubbles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/buildings" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bullet-list" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/calculator" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/calendar-check" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/calendar" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/calender-add" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/call" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/car" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/carussel" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chain-link-broken" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chain-link" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chart-two" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/checklist" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/checkmark" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-bottom" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-double-down" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-double-left" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-double-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-double-up" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-down-small" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-grabber-vertical-reversed" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-grabber-vertical" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-left-small" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-left" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-right-small" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-top-small" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-top" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-ban" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-check" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-dots" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-info" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-minus" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-placeholder-on" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-plus" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-questionmark" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-x" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circles-three" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/clock" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cloud-download" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cloud-upload" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cloudy-sun" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/code-brackets" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/code" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/compass-round" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cookies" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/copy" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/credit-card-add" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/credit-card" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cross-large" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cross-small" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cup-hot" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cursor" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/devices" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/direction" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/dollar" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/dot-grid-one-horizontal" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/dot-grid-one-vertical" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/dot-grid-three" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/dot-grid-two" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/email" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/emoji-angry" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/emoji-neutral" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/emoji-sad" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/emoji-smile" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/emoji-smiley" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/euro" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/expand" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/eye-open" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/eye-slash" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/fashion" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/fast-forward" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/file-bend" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/file-chart" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/file-text" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/files" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/filter" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/flag" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/floppy-disk" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/focus" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/folder-add-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/folder" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/fullscreen" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/gift" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/globus" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/graduate-cap" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/green-power" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/group" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/growth" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/headphones" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/heart-beat" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/heart" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/history" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/home-energy-one" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/home-energy-two" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/home-open" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/home-roof" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/horizontal-alignment-bottom" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/hourglass" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/images" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/inbox-empty" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/industry" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/jpg" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/key" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/knife-spoon" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/lab" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/law" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/leisure" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/light-bulb-simple" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/lightning" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/line-chart-four" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/line-chart-one" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/line-chart-three" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/line-chart-two" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/lock" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/macbook-air" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/magnifying-glass" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/map-pin" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/megaphone" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/menu-sidebar" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/mic-off" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/mic-on" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/minimize" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/minus-large" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/minus-small" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/money-hand" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/moneybag" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/moon" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/mute" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/office" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/page-add" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/paper-plane-top-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/paperclip" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pause" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pdf" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pencil-sign" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pencil-sparkle" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pencil-wave" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pension" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-a11y" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-add" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-added" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-circle" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-copy" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-profile" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-remove" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/percent" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/phone" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pie-chart" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/piggy-bank" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pin" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pinch" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/play-circle" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/play" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/plus-large" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/plus-small" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/png" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/poop" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/postcard" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pound" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/power-plant" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/power" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/printer" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/push" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/qr-code" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/rainy" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/raising-hand" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/reading-list" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/receipt-bill" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/receiption-bell" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/record" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/refund" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/robot" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/rocket" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/run-shortcut" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/safari" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/school" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/scissors" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/search-menu" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/settings-gear" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/settings-slider-hor" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/settings-slider-ver" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/shapes" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/share" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/shield-checked" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/shield-crossed" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/shield" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/shopping-bag" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/signature" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/smartwatch" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/solar" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sort-ascending" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sort-descending" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sort-down" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sort-up" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sort" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/square-arrow-top-right" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/square-behind-square" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/square-grid-circle" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/square-placeholder" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/star" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/store" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sun" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sunset-arrow-down" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/tag" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/target-arrow" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/television" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/tennis" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/text-edit" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/thermostat" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/thumbs-down" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/thumbs-up" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/ticket" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trading-view-candles" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trash-can" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/tree" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trending-five" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trending-four" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trending-one" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trending-three" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trending-two" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/triangle-exclamation" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/truck" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/umbrella-security" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/unlocked" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/volume-full" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/volume-half" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/volume-off" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/wallet" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/warning-sign" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/wifi-full" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/youtube" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/zap" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/zoom-in" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/zoom-out" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/industry.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconIndustry", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-industry", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconIndustry", "declaration": { "name": "IconIndustry", "module": "src/components/icon/icons/industry.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/industry.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconIndustry", "declaration": { "name": "IconIndustry", "module": "src/components/icon/icons/industry.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/jpg.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconJpg", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-jpg", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconJpg", "declaration": { "name": "IconJpg", "module": "src/components/icon/icons/jpg.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/jpg.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconJpg", "declaration": { "name": "IconJpg", "module": "src/components/icon/icons/jpg.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/key.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconKey", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-key", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconKey", "declaration": { "name": "IconKey", "module": "src/components/icon/icons/key.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/key.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconKey", "declaration": { "name": "IconKey", "module": "src/components/icon/icons/key.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/knife-spoon.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconKnifeSpoon", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-knife-spoon", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconKnifeSpoon", "declaration": { "name": "IconKnifeSpoon", "module": "src/components/icon/icons/knife-spoon.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/knife-spoon.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconKnifeSpoon", "declaration": { "name": "IconKnifeSpoon", "module": "src/components/icon/icons/knife-spoon.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/lab.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconLab", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-lab", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconLab", "declaration": { "name": "IconLab", "module": "src/components/icon/icons/lab.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/lab.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconLab", "declaration": { "name": "IconLab", "module": "src/components/icon/icons/lab.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/law.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconLaw", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-law", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconLaw", "declaration": { "name": "IconLaw", "module": "src/components/icon/icons/law.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/law.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconLaw", "declaration": { "name": "IconLaw", "module": "src/components/icon/icons/law.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/leisure.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconLeisure", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-leisure", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconLeisure", "declaration": { "name": "IconLeisure", "module": "src/components/icon/icons/leisure.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/leisure.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconLeisure", "declaration": { "name": "IconLeisure", "module": "src/components/icon/icons/leisure.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/light-bulb-simple.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconLightBulbSimple", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-light-bulb-simple", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconLightBulbSimple", "declaration": { "name": "IconLightBulbSimple", "module": "src/components/icon/icons/light-bulb-simple.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/light-bulb-simple.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconLightBulbSimple", "declaration": { "name": "IconLightBulbSimple", "module": "src/components/icon/icons/light-bulb-simple.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/lightning.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconLightning", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-lightning", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconLightning", "declaration": { "name": "IconLightning", "module": "src/components/icon/icons/lightning.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/lightning.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconLightning", "declaration": { "name": "IconLightning", "module": "src/components/icon/icons/lightning.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/line-chart-four.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconLineChartFour", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-line-chart-four", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconLineChartFour", "declaration": { "name": "IconLineChartFour", "module": "src/components/icon/icons/line-chart-four.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/line-chart-four.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconLineChartFour", "declaration": { "name": "IconLineChartFour", "module": "src/components/icon/icons/line-chart-four.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/line-chart-one.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconLineChartOne", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-line-chart-one", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconLineChartOne", "declaration": { "name": "IconLineChartOne", "module": "src/components/icon/icons/line-chart-one.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/line-chart-one.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconLineChartOne", "declaration": { "name": "IconLineChartOne", "module": "src/components/icon/icons/line-chart-one.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/line-chart-three.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconLineChartThree", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-line-chart-three", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconLineChartThree", "declaration": { "name": "IconLineChartThree", "module": "src/components/icon/icons/line-chart-three.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/line-chart-three.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconLineChartThree", "declaration": { "name": "IconLineChartThree", "module": "src/components/icon/icons/line-chart-three.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/line-chart-two.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconLineChartTwo", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-line-chart-two", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconLineChartTwo", "declaration": { "name": "IconLineChartTwo", "module": "src/components/icon/icons/line-chart-two.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/line-chart-two.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconLineChartTwo", "declaration": { "name": "IconLineChartTwo", "module": "src/components/icon/icons/line-chart-two.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/lock.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconLock", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-lock", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconLock", "declaration": { "name": "IconLock", "module": "src/components/icon/icons/lock.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/lock.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconLock", "declaration": { "name": "IconLock", "module": "src/components/icon/icons/lock.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/macbook-air.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMacbookAir", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-macbook-air", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMacbookAir", "declaration": { "name": "IconMacbookAir", "module": "src/components/icon/icons/macbook-air.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/macbook-air.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMacbookAir", "declaration": { "name": "IconMacbookAir", "module": "src/components/icon/icons/macbook-air.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/magnifying-glass.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMagnifyingGlass", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-magnifying-glass", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMagnifyingGlass", "declaration": { "name": "IconMagnifyingGlass", "module": "src/components/icon/icons/magnifying-glass.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/magnifying-glass.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMagnifyingGlass", "declaration": { "name": "IconMagnifyingGlass", "module": "src/components/icon/icons/magnifying-glass.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/map-pin.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMapPin", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-map-pin", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMapPin", "declaration": { "name": "IconMapPin", "module": "src/components/icon/icons/map-pin.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/map-pin.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMapPin", "declaration": { "name": "IconMapPin", "module": "src/components/icon/icons/map-pin.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/megaphone.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMegaphone", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-megaphone", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMegaphone", "declaration": { "name": "IconMegaphone", "module": "src/components/icon/icons/megaphone.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/megaphone.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMegaphone", "declaration": { "name": "IconMegaphone", "module": "src/components/icon/icons/megaphone.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/menu-sidebar.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMenuSidebar", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-menu-sidebar", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMenuSidebar", "declaration": { "name": "IconMenuSidebar", "module": "src/components/icon/icons/menu-sidebar.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/menu-sidebar.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMenuSidebar", "declaration": { "name": "IconMenuSidebar", "module": "src/components/icon/icons/menu-sidebar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/mic-off.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMicOff", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-mic-off", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMicOff", "declaration": { "name": "IconMicOff", "module": "src/components/icon/icons/mic-off.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/mic-off.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMicOff", "declaration": { "name": "IconMicOff", "module": "src/components/icon/icons/mic-off.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/mic-on.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMicOn", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-mic-on", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMicOn", "declaration": { "name": "IconMicOn", "module": "src/components/icon/icons/mic-on.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/mic-on.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMicOn", "declaration": { "name": "IconMicOn", "module": "src/components/icon/icons/mic-on.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/minimize.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMinimize", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-minimize", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMinimize", "declaration": { "name": "IconMinimize", "module": "src/components/icon/icons/minimize.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/minimize.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMinimize", "declaration": { "name": "IconMinimize", "module": "src/components/icon/icons/minimize.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/minus-large.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMinusLarge", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-minus-large", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMinusLarge", "declaration": { "name": "IconMinusLarge", "module": "src/components/icon/icons/minus-large.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/minus-large.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMinusLarge", "declaration": { "name": "IconMinusLarge", "module": "src/components/icon/icons/minus-large.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/minus-small.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMinusSmall", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-minus-small", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMinusSmall", "declaration": { "name": "IconMinusSmall", "module": "src/components/icon/icons/minus-small.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/minus-small.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMinusSmall", "declaration": { "name": "IconMinusSmall", "module": "src/components/icon/icons/minus-small.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/money-hand.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMoneyHand", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-money-hand", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMoneyHand", "declaration": { "name": "IconMoneyHand", "module": "src/components/icon/icons/money-hand.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/money-hand.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMoneyHand", "declaration": { "name": "IconMoneyHand", "module": "src/components/icon/icons/money-hand.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/moneybag.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMoneybag", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-moneybag", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMoneybag", "declaration": { "name": "IconMoneybag", "module": "src/components/icon/icons/moneybag.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/moneybag.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMoneybag", "declaration": { "name": "IconMoneybag", "module": "src/components/icon/icons/moneybag.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/moon.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMoon", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-moon", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMoon", "declaration": { "name": "IconMoon", "module": "src/components/icon/icons/moon.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/moon.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMoon", "declaration": { "name": "IconMoon", "module": "src/components/icon/icons/moon.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/mute.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconMute", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-mute", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconMute", "declaration": { "name": "IconMute", "module": "src/components/icon/icons/mute.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/mute.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconMute", "declaration": { "name": "IconMute", "module": "src/components/icon/icons/mute.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/office.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconOffice", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-office", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconOffice", "declaration": { "name": "IconOffice", "module": "src/components/icon/icons/office.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/office.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconOffice", "declaration": { "name": "IconOffice", "module": "src/components/icon/icons/office.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/page-add.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPageAdd", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-page-add", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPageAdd", "declaration": { "name": "IconPageAdd", "module": "src/components/icon/icons/page-add.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/page-add.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPageAdd", "declaration": { "name": "IconPageAdd", "module": "src/components/icon/icons/page-add.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/paper-plane-top-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPaperPlaneTopRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-paper-plane-top-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPaperPlaneTopRight", "declaration": { "name": "IconPaperPlaneTopRight", "module": "src/components/icon/icons/paper-plane-top-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/paper-plane-top-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPaperPlaneTopRight", "declaration": { "name": "IconPaperPlaneTopRight", "module": "src/components/icon/icons/paper-plane-top-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/paperclip.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPaperclip", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-paperclip", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPaperclip", "declaration": { "name": "IconPaperclip", "module": "src/components/icon/icons/paperclip.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/paperclip.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPaperclip", "declaration": { "name": "IconPaperclip", "module": "src/components/icon/icons/paperclip.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pause.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPause", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-pause", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPause", "declaration": { "name": "IconPause", "module": "src/components/icon/icons/pause.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pause.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPause", "declaration": { "name": "IconPause", "module": "src/components/icon/icons/pause.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pdf.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPdf", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-pdf", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPdf", "declaration": { "name": "IconPdf", "module": "src/components/icon/icons/pdf.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pdf.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPdf", "declaration": { "name": "IconPdf", "module": "src/components/icon/icons/pdf.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pencil-sign.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPencilSign", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-pencil-sign", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPencilSign", "declaration": { "name": "IconPencilSign", "module": "src/components/icon/icons/pencil-sign.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pencil-sign.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPencilSign", "declaration": { "name": "IconPencilSign", "module": "src/components/icon/icons/pencil-sign.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pencil-sparkle.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPencilSparkle", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-pencil-sparkle", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPencilSparkle", "declaration": { "name": "IconPencilSparkle", "module": "src/components/icon/icons/pencil-sparkle.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pencil-sparkle.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPencilSparkle", "declaration": { "name": "IconPencilSparkle", "module": "src/components/icon/icons/pencil-sparkle.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pencil-wave.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPencilWave", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-pencil-wave", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPencilWave", "declaration": { "name": "IconPencilWave", "module": "src/components/icon/icons/pencil-wave.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pencil-wave.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPencilWave", "declaration": { "name": "IconPencilWave", "module": "src/components/icon/icons/pencil-wave.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pension.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPension", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-pension", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPension", "declaration": { "name": "IconPension", "module": "src/components/icon/icons/pension.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pension.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPension", "declaration": { "name": "IconPension", "module": "src/components/icon/icons/pension.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-a11y.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPeopleA11y", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-people-a11y", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleA11y", "declaration": { "name": "IconPeopleA11y", "module": "src/components/icon/icons/people-a11y.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-a11y.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPeopleA11y", "declaration": { "name": "IconPeopleA11y", "module": "src/components/icon/icons/people-a11y.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-add.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPeopleAdd", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-people-add", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleAdd", "declaration": { "name": "IconPeopleAdd", "module": "src/components/icon/icons/people-add.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-add.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPeopleAdd", "declaration": { "name": "IconPeopleAdd", "module": "src/components/icon/icons/people-add.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-added.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPeopleAdded", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-people-added", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleAdded", "declaration": { "name": "IconPeopleAdded", "module": "src/components/icon/icons/people-added.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-added.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPeopleAdded", "declaration": { "name": "IconPeopleAdded", "module": "src/components/icon/icons/people-added.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-circle.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPeopleCircle", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-people-circle", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleCircle", "declaration": { "name": "IconPeopleCircle", "module": "src/components/icon/icons/people-circle.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-circle.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPeopleCircle", "declaration": { "name": "IconPeopleCircle", "module": "src/components/icon/icons/people-circle.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-copy.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPeopleCopy", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-people-copy", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleCopy", "declaration": { "name": "IconPeopleCopy", "module": "src/components/icon/icons/people-copy.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-copy.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPeopleCopy", "declaration": { "name": "IconPeopleCopy", "module": "src/components/icon/icons/people-copy.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-profile.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPeopleProfile", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-people-profile", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleProfile", "declaration": { "name": "IconPeopleProfile", "module": "src/components/icon/icons/people-profile.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-profile.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPeopleProfile", "declaration": { "name": "IconPeopleProfile", "module": "src/components/icon/icons/people-profile.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-remove.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPeopleRemove", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-people-remove", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleRemove", "declaration": { "name": "IconPeopleRemove", "module": "src/components/icon/icons/people-remove.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people-remove.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPeopleRemove", "declaration": { "name": "IconPeopleRemove", "module": "src/components/icon/icons/people-remove.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPeople", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-people", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeople", "declaration": { "name": "IconPeople", "module": "src/components/icon/icons/people.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/people.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPeople", "declaration": { "name": "IconPeople", "module": "src/components/icon/icons/people.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/percent.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPercent", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-percent", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPercent", "declaration": { "name": "IconPercent", "module": "src/components/icon/icons/percent.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/percent.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPercent", "declaration": { "name": "IconPercent", "module": "src/components/icon/icons/percent.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/phone.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPhone", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-phone", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPhone", "declaration": { "name": "IconPhone", "module": "src/components/icon/icons/phone.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/phone.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPhone", "declaration": { "name": "IconPhone", "module": "src/components/icon/icons/phone.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pie-chart.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPieChart", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-pie-chart", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPieChart", "declaration": { "name": "IconPieChart", "module": "src/components/icon/icons/pie-chart.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pie-chart.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPieChart", "declaration": { "name": "IconPieChart", "module": "src/components/icon/icons/pie-chart.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/piggy-bank.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPiggyBank", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-piggy-bank", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPiggyBank", "declaration": { "name": "IconPiggyBank", "module": "src/components/icon/icons/piggy-bank.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/piggy-bank.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPiggyBank", "declaration": { "name": "IconPiggyBank", "module": "src/components/icon/icons/piggy-bank.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pin.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPin", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-pin", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPin", "declaration": { "name": "IconPin", "module": "src/components/icon/icons/pin.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pin.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPin", "declaration": { "name": "IconPin", "module": "src/components/icon/icons/pin.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pinch.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPinch", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-pinch", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPinch", "declaration": { "name": "IconPinch", "module": "src/components/icon/icons/pinch.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pinch.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPinch", "declaration": { "name": "IconPinch", "module": "src/components/icon/icons/pinch.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/play-circle.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPlayCircle", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-play-circle", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPlayCircle", "declaration": { "name": "IconPlayCircle", "module": "src/components/icon/icons/play-circle.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/play-circle.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPlayCircle", "declaration": { "name": "IconPlayCircle", "module": "src/components/icon/icons/play-circle.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/play.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPlay", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-play", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPlay", "declaration": { "name": "IconPlay", "module": "src/components/icon/icons/play.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/play.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPlay", "declaration": { "name": "IconPlay", "module": "src/components/icon/icons/play.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/plus-large.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPlusLarge", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-plus-large", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPlusLarge", "declaration": { "name": "IconPlusLarge", "module": "src/components/icon/icons/plus-large.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/plus-large.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPlusLarge", "declaration": { "name": "IconPlusLarge", "module": "src/components/icon/icons/plus-large.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/plus-small.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPlusSmall", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-plus-small", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPlusSmall", "declaration": { "name": "IconPlusSmall", "module": "src/components/icon/icons/plus-small.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/plus-small.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPlusSmall", "declaration": { "name": "IconPlusSmall", "module": "src/components/icon/icons/plus-small.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/png.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPng", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-png", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPng", "declaration": { "name": "IconPng", "module": "src/components/icon/icons/png.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/png.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPng", "declaration": { "name": "IconPng", "module": "src/components/icon/icons/png.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/poop.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPoop", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-poop", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPoop", "declaration": { "name": "IconPoop", "module": "src/components/icon/icons/poop.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/poop.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPoop", "declaration": { "name": "IconPoop", "module": "src/components/icon/icons/poop.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/postcard.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPostcard", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-postcard", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPostcard", "declaration": { "name": "IconPostcard", "module": "src/components/icon/icons/postcard.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/postcard.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPostcard", "declaration": { "name": "IconPostcard", "module": "src/components/icon/icons/postcard.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pound.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPound", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-pound", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPound", "declaration": { "name": "IconPound", "module": "src/components/icon/icons/pound.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pound.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPound", "declaration": { "name": "IconPound", "module": "src/components/icon/icons/pound.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/power-plant.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPowerPlant", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-power-plant", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPowerPlant", "declaration": { "name": "IconPowerPlant", "module": "src/components/icon/icons/power-plant.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/power-plant.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPowerPlant", "declaration": { "name": "IconPowerPlant", "module": "src/components/icon/icons/power-plant.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/power.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPower", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-power", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPower", "declaration": { "name": "IconPower", "module": "src/components/icon/icons/power.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/power.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPower", "declaration": { "name": "IconPower", "module": "src/components/icon/icons/power.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/printer.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPrinter", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-printer", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPrinter", "declaration": { "name": "IconPrinter", "module": "src/components/icon/icons/printer.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/printer.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPrinter", "declaration": { "name": "IconPrinter", "module": "src/components/icon/icons/printer.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/pure.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/ai.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/airplane-up.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/archive.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-bottom-top.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-box-left-alt.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-box-left.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-box-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-down.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-inbox.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-left-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-left.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-out-of-box.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-right-circle.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-right-down-circle.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-right-up-circle.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-rotate-clockwise.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-rotate-counter-clockwise.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-rotate-left-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-rotate-right-left.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-share-left.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-share-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-split.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-up.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-wall-down.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-wall-left.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-wall-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow-wall-up.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/arrow.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/asterisk.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/at.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/back.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/backward.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bag.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bank.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/banknote-2.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/banknote.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/barcode.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bars-three.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bars-two.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/basket.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/battery-loading.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bell.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/block.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/book.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bookmark-check.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bookmark-delete.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bookmark-plus.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bookmark-remove.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bookmark.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/books.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-app-store.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-apple-music.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-bankid.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-chrome.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-facebook.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-figma.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-firefox.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-github.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-green.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-instagram.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-linkedin.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-play-store.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-rss-feed.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-seb.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-spotify.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-storybook.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-swish-word.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brand-x.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/brush.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bubble-annotation.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bubbles.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/buildings.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/bullet-list.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/calculator.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/calendar-check.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/calendar.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/calender-add.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/call.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/car.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/carussel.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chain-link-broken.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chain-link.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chart-two.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/checklist.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/checkmark.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-bottom.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-double-down.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-double-left.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-double-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-double-up.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-down-small.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-grabber-vertical-reversed.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-grabber-vertical.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-left-small.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-left.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-right-small.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-top-small.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/chevron-top.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-ban.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-check.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-dots.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-info.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-minus.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-placeholder-on.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-plus.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-questionmark.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circle-x.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/circles-three.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/clock.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cloud-download.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cloud-upload.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cloudy-sun.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/code-brackets.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/code.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/compass-round.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cookies.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/copy.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/credit-card-add.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/credit-card.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cross-large.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cross-small.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cup-hot.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/cursor.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/devices.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/direction.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/dollar.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/dot-grid-one-horizontal.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/dot-grid-one-vertical.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/dot-grid-three.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/dot-grid-two.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/email.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/emoji-angry.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/emoji-neutral.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/emoji-sad.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/emoji-smile.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/emoji-smiley.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/euro.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/expand.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/eye-open.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/eye-slash.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/fashion.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/fast-forward.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/file-bend.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/file-chart.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/file-text.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/files.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/filter.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/flag.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/floppy-disk.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/focus.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/folder-add-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/folder.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/fullscreen.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/gift.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/globus.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/graduate-cap.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/green-power.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/group.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/growth.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/headphones.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/heart-beat.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/heart.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/history.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/home-energy-one.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/home-energy-two.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/home-open.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/home-roof.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/horizontal-alignment-bottom.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/hourglass.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/images.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/inbox-empty.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/industry.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/jpg.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/key.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/knife-spoon.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/lab.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/law.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/leisure.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/light-bulb-simple.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/lightning.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/line-chart-four.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/line-chart-one.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/line-chart-three.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/line-chart-two.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/lock.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/macbook-air.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/magnifying-glass.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/map-pin.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/megaphone.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/menu-sidebar.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/mic-off.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/mic-on.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/minimize.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/minus-large.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/minus-small.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/money-hand.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/moneybag.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/moon.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/mute.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/office.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/page-add.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/paper-plane-top-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/paperclip.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pause.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pdf.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pencil-sign.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pencil-sparkle.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pencil-wave.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pension.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-a11y.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-add.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-added.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-circle.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-copy.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-profile.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people-remove.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/people.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/percent.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/phone.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pie-chart.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/piggy-bank.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pin.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pinch.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/play-circle.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/play.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/plus-large.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/plus-small.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/png.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/poop.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/postcard.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/pound.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/power-plant.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/power.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/printer.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/push.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/qr-code.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/rainy.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/raising-hand.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/reading-list.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/receipt-bill.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/receiption-bell.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/record.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/refund.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/robot.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/rocket.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/run-shortcut.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/safari.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/school.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/scissors.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/search-menu.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/settings-gear.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/settings-slider-hor.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/settings-slider-ver.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/shapes.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/share.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/shield-checked.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/shield-crossed.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/shield.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/shopping-bag.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/signature.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/smartwatch.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/solar.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sort-ascending.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sort-descending.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sort-down.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sort-up.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sort.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/square-arrow-top-right.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/square-behind-square.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/square-grid-circle.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/square-placeholder.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/star.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/store.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sun.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/sunset-arrow-down.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/tag.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/target-arrow.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/television.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/tennis.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/text-edit.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/thermostat.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/thumbs-down.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/thumbs-up.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/ticket.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trading-view-candles.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trash-can.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/tree.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trending-five.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trending-four.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trending-one.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trending-three.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/trending-two.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/triangle-exclamation.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/truck.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/umbrella-security.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/unlocked.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/volume-full.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/volume-half.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/volume-off.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/wallet.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/warning-sign.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/wifi-full.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/youtube.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/zap.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/zoom-in.component" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/icon/icons/zoom-out.component" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/push.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconPush", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-push", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconPush", "declaration": { "name": "IconPush", "module": "src/components/icon/icons/push.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/push.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconPush", "declaration": { "name": "IconPush", "module": "src/components/icon/icons/push.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/qr-code.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconQrCode", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-qr-code", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconQrCode", "declaration": { "name": "IconQrCode", "module": "src/components/icon/icons/qr-code.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/qr-code.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconQrCode", "declaration": { "name": "IconQrCode", "module": "src/components/icon/icons/qr-code.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/rainy.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconRainy", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-rainy", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconRainy", "declaration": { "name": "IconRainy", "module": "src/components/icon/icons/rainy.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/rainy.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconRainy", "declaration": { "name": "IconRainy", "module": "src/components/icon/icons/rainy.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/raising-hand.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconRaisingHand", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-raising-hand", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconRaisingHand", "declaration": { "name": "IconRaisingHand", "module": "src/components/icon/icons/raising-hand.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/raising-hand.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconRaisingHand", "declaration": { "name": "IconRaisingHand", "module": "src/components/icon/icons/raising-hand.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/reading-list.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconReadingList", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-reading-list", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconReadingList", "declaration": { "name": "IconReadingList", "module": "src/components/icon/icons/reading-list.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/reading-list.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconReadingList", "declaration": { "name": "IconReadingList", "module": "src/components/icon/icons/reading-list.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/receipt-bill.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconReceiptBill", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-receipt-bill", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconReceiptBill", "declaration": { "name": "IconReceiptBill", "module": "src/components/icon/icons/receipt-bill.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/receipt-bill.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconReceiptBill", "declaration": { "name": "IconReceiptBill", "module": "src/components/icon/icons/receipt-bill.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/receiption-bell.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconReceiptionBell", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-receiption-bell", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconReceiptionBell", "declaration": { "name": "IconReceiptionBell", "module": "src/components/icon/icons/receiption-bell.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/receiption-bell.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconReceiptionBell", "declaration": { "name": "IconReceiptionBell", "module": "src/components/icon/icons/receiption-bell.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/record.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconRecord", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-record", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconRecord", "declaration": { "name": "IconRecord", "module": "src/components/icon/icons/record.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/record.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconRecord", "declaration": { "name": "IconRecord", "module": "src/components/icon/icons/record.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/refund.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconRefund", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-refund", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconRefund", "declaration": { "name": "IconRefund", "module": "src/components/icon/icons/refund.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/refund.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconRefund", "declaration": { "name": "IconRefund", "module": "src/components/icon/icons/refund.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/robot.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconRobot", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-robot", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconRobot", "declaration": { "name": "IconRobot", "module": "src/components/icon/icons/robot.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/robot.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconRobot", "declaration": { "name": "IconRobot", "module": "src/components/icon/icons/robot.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/rocket.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconRocket", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-rocket", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconRocket", "declaration": { "name": "IconRocket", "module": "src/components/icon/icons/rocket.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/rocket.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconRocket", "declaration": { "name": "IconRocket", "module": "src/components/icon/icons/rocket.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/run-shortcut.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconRunShortcut", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-run-shortcut", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconRunShortcut", "declaration": { "name": "IconRunShortcut", "module": "src/components/icon/icons/run-shortcut.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/run-shortcut.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconRunShortcut", "declaration": { "name": "IconRunShortcut", "module": "src/components/icon/icons/run-shortcut.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/safari.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSafari", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-safari", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSafari", "declaration": { "name": "IconSafari", "module": "src/components/icon/icons/safari.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/safari.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSafari", "declaration": { "name": "IconSafari", "module": "src/components/icon/icons/safari.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/school.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSchool", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-school", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSchool", "declaration": { "name": "IconSchool", "module": "src/components/icon/icons/school.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/school.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSchool", "declaration": { "name": "IconSchool", "module": "src/components/icon/icons/school.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/scissors.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconScissors", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-scissors", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconScissors", "declaration": { "name": "IconScissors", "module": "src/components/icon/icons/scissors.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/scissors.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconScissors", "declaration": { "name": "IconScissors", "module": "src/components/icon/icons/scissors.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/search-menu.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSearchMenu", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-search-menu", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSearchMenu", "declaration": { "name": "IconSearchMenu", "module": "src/components/icon/icons/search-menu.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/search-menu.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSearchMenu", "declaration": { "name": "IconSearchMenu", "module": "src/components/icon/icons/search-menu.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/settings-gear.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSettingsGear", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-settings-gear", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSettingsGear", "declaration": { "name": "IconSettingsGear", "module": "src/components/icon/icons/settings-gear.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/settings-gear.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSettingsGear", "declaration": { "name": "IconSettingsGear", "module": "src/components/icon/icons/settings-gear.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/settings-slider-hor.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSettingsSliderHor", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-settings-slider-hor", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSettingsSliderHor", "declaration": { "name": "IconSettingsSliderHor", "module": "src/components/icon/icons/settings-slider-hor.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/settings-slider-hor.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSettingsSliderHor", "declaration": { "name": "IconSettingsSliderHor", "module": "src/components/icon/icons/settings-slider-hor.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/settings-slider-ver.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSettingsSliderVer", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-settings-slider-ver", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSettingsSliderVer", "declaration": { "name": "IconSettingsSliderVer", "module": "src/components/icon/icons/settings-slider-ver.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/settings-slider-ver.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSettingsSliderVer", "declaration": { "name": "IconSettingsSliderVer", "module": "src/components/icon/icons/settings-slider-ver.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/shapes.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconShapes", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-shapes", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconShapes", "declaration": { "name": "IconShapes", "module": "src/components/icon/icons/shapes.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/shapes.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconShapes", "declaration": { "name": "IconShapes", "module": "src/components/icon/icons/shapes.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/share.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconShare", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-share", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconShare", "declaration": { "name": "IconShare", "module": "src/components/icon/icons/share.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/share.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconShare", "declaration": { "name": "IconShare", "module": "src/components/icon/icons/share.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/shield-checked.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconShieldChecked", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-shield-checked", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconShieldChecked", "declaration": { "name": "IconShieldChecked", "module": "src/components/icon/icons/shield-checked.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/shield-checked.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconShieldChecked", "declaration": { "name": "IconShieldChecked", "module": "src/components/icon/icons/shield-checked.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/shield-crossed.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconShieldCrossed", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-shield-crossed", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconShieldCrossed", "declaration": { "name": "IconShieldCrossed", "module": "src/components/icon/icons/shield-crossed.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/shield-crossed.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconShieldCrossed", "declaration": { "name": "IconShieldCrossed", "module": "src/components/icon/icons/shield-crossed.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/shield.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconShield", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-shield", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconShield", "declaration": { "name": "IconShield", "module": "src/components/icon/icons/shield.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/shield.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconShield", "declaration": { "name": "IconShield", "module": "src/components/icon/icons/shield.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/shopping-bag.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconShoppingBag", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-shopping-bag", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconShoppingBag", "declaration": { "name": "IconShoppingBag", "module": "src/components/icon/icons/shopping-bag.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/shopping-bag.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconShoppingBag", "declaration": { "name": "IconShoppingBag", "module": "src/components/icon/icons/shopping-bag.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/signature.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSignature", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-signature", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSignature", "declaration": { "name": "IconSignature", "module": "src/components/icon/icons/signature.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/signature.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSignature", "declaration": { "name": "IconSignature", "module": "src/components/icon/icons/signature.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/smartwatch.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSmartwatch", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-smartwatch", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSmartwatch", "declaration": { "name": "IconSmartwatch", "module": "src/components/icon/icons/smartwatch.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/smartwatch.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSmartwatch", "declaration": { "name": "IconSmartwatch", "module": "src/components/icon/icons/smartwatch.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/solar.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSolar", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-solar", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSolar", "declaration": { "name": "IconSolar", "module": "src/components/icon/icons/solar.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/solar.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSolar", "declaration": { "name": "IconSolar", "module": "src/components/icon/icons/solar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sort-ascending.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSortAscending", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-sort-ascending", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSortAscending", "declaration": { "name": "IconSortAscending", "module": "src/components/icon/icons/sort-ascending.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sort-ascending.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSortAscending", "declaration": { "name": "IconSortAscending", "module": "src/components/icon/icons/sort-ascending.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sort-descending.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSortDescending", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-sort-descending", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSortDescending", "declaration": { "name": "IconSortDescending", "module": "src/components/icon/icons/sort-descending.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sort-descending.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSortDescending", "declaration": { "name": "IconSortDescending", "module": "src/components/icon/icons/sort-descending.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sort-down.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSortDown", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-sort-down", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSortDown", "declaration": { "name": "IconSortDown", "module": "src/components/icon/icons/sort-down.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sort-down.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSortDown", "declaration": { "name": "IconSortDown", "module": "src/components/icon/icons/sort-down.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sort-up.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSortUp", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-sort-up", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSortUp", "declaration": { "name": "IconSortUp", "module": "src/components/icon/icons/sort-up.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sort-up.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSortUp", "declaration": { "name": "IconSortUp", "module": "src/components/icon/icons/sort-up.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sort.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSort", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-sort", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSort", "declaration": { "name": "IconSort", "module": "src/components/icon/icons/sort.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sort.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSort", "declaration": { "name": "IconSort", "module": "src/components/icon/icons/sort.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/square-arrow-top-right.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSquareArrowTopRight", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-square-arrow-top-right", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSquareArrowTopRight", "declaration": { "name": "IconSquareArrowTopRight", "module": "src/components/icon/icons/square-arrow-top-right.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/square-arrow-top-right.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSquareArrowTopRight", "declaration": { "name": "IconSquareArrowTopRight", "module": "src/components/icon/icons/square-arrow-top-right.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/square-behind-square.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSquareBehindSquare", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-square-behind-square", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSquareBehindSquare", "declaration": { "name": "IconSquareBehindSquare", "module": "src/components/icon/icons/square-behind-square.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/square-behind-square.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSquareBehindSquare", "declaration": { "name": "IconSquareBehindSquare", "module": "src/components/icon/icons/square-behind-square.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/square-grid-circle.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSquareGridCircle", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-square-grid-circle", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSquareGridCircle", "declaration": { "name": "IconSquareGridCircle", "module": "src/components/icon/icons/square-grid-circle.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/square-grid-circle.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSquareGridCircle", "declaration": { "name": "IconSquareGridCircle", "module": "src/components/icon/icons/square-grid-circle.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/square-placeholder.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSquarePlaceholder", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-square-placeholder", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSquarePlaceholder", "declaration": { "name": "IconSquarePlaceholder", "module": "src/components/icon/icons/square-placeholder.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/square-placeholder.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSquarePlaceholder", "declaration": { "name": "IconSquarePlaceholder", "module": "src/components/icon/icons/square-placeholder.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/star.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconStar", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-star", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconStar", "declaration": { "name": "IconStar", "module": "src/components/icon/icons/star.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/star.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconStar", "declaration": { "name": "IconStar", "module": "src/components/icon/icons/star.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/store.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconStore", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-store", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconStore", "declaration": { "name": "IconStore", "module": "src/components/icon/icons/store.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/store.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconStore", "declaration": { "name": "IconStore", "module": "src/components/icon/icons/store.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sun.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSun", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-sun", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSun", "declaration": { "name": "IconSun", "module": "src/components/icon/icons/sun.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sun.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSun", "declaration": { "name": "IconSun", "module": "src/components/icon/icons/sun.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sunset-arrow-down.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconSunsetArrowDown", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-sunset-arrow-down", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconSunsetArrowDown", "declaration": { "name": "IconSunsetArrowDown", "module": "src/components/icon/icons/sunset-arrow-down.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/sunset-arrow-down.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconSunsetArrowDown", "declaration": { "name": "IconSunsetArrowDown", "module": "src/components/icon/icons/sunset-arrow-down.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/tag.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTag", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-tag", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTag", "declaration": { "name": "IconTag", "module": "src/components/icon/icons/tag.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/tag.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTag", "declaration": { "name": "IconTag", "module": "src/components/icon/icons/tag.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/target-arrow.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTargetArrow", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-target-arrow", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTargetArrow", "declaration": { "name": "IconTargetArrow", "module": "src/components/icon/icons/target-arrow.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/target-arrow.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTargetArrow", "declaration": { "name": "IconTargetArrow", "module": "src/components/icon/icons/target-arrow.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/television.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTelevision", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-television", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTelevision", "declaration": { "name": "IconTelevision", "module": "src/components/icon/icons/television.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/television.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTelevision", "declaration": { "name": "IconTelevision", "module": "src/components/icon/icons/television.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/tennis.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTennis", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-tennis", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTennis", "declaration": { "name": "IconTennis", "module": "src/components/icon/icons/tennis.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/tennis.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTennis", "declaration": { "name": "IconTennis", "module": "src/components/icon/icons/tennis.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/text-edit.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTextEdit", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-text-edit", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTextEdit", "declaration": { "name": "IconTextEdit", "module": "src/components/icon/icons/text-edit.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/text-edit.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTextEdit", "declaration": { "name": "IconTextEdit", "module": "src/components/icon/icons/text-edit.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/thermostat.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconThermostat", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-thermostat", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconThermostat", "declaration": { "name": "IconThermostat", "module": "src/components/icon/icons/thermostat.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/thermostat.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconThermostat", "declaration": { "name": "IconThermostat", "module": "src/components/icon/icons/thermostat.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/thumbs-down.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconThumbsDown", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-thumbs-down", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconThumbsDown", "declaration": { "name": "IconThumbsDown", "module": "src/components/icon/icons/thumbs-down.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/thumbs-down.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconThumbsDown", "declaration": { "name": "IconThumbsDown", "module": "src/components/icon/icons/thumbs-down.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/thumbs-up.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconThumbsUp", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-thumbs-up", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconThumbsUp", "declaration": { "name": "IconThumbsUp", "module": "src/components/icon/icons/thumbs-up.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/thumbs-up.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconThumbsUp", "declaration": { "name": "IconThumbsUp", "module": "src/components/icon/icons/thumbs-up.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/ticket.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTicket", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-ticket", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTicket", "declaration": { "name": "IconTicket", "module": "src/components/icon/icons/ticket.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/ticket.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTicket", "declaration": { "name": "IconTicket", "module": "src/components/icon/icons/ticket.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trading-view-candles.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTradingViewCandles", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-trading-view-candles", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTradingViewCandles", "declaration": { "name": "IconTradingViewCandles", "module": "src/components/icon/icons/trading-view-candles.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trading-view-candles.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTradingViewCandles", "declaration": { "name": "IconTradingViewCandles", "module": "src/components/icon/icons/trading-view-candles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trash-can.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTrashCan", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-trash-can", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrashCan", "declaration": { "name": "IconTrashCan", "module": "src/components/icon/icons/trash-can.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trash-can.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTrashCan", "declaration": { "name": "IconTrashCan", "module": "src/components/icon/icons/trash-can.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/tree.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTree", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-tree", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTree", "declaration": { "name": "IconTree", "module": "src/components/icon/icons/tree.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/tree.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTree", "declaration": { "name": "IconTree", "module": "src/components/icon/icons/tree.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trending-five.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTrendingFive", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-trending-five", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrendingFive", "declaration": { "name": "IconTrendingFive", "module": "src/components/icon/icons/trending-five.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trending-five.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTrendingFive", "declaration": { "name": "IconTrendingFive", "module": "src/components/icon/icons/trending-five.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trending-four.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTrendingFour", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-trending-four", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrendingFour", "declaration": { "name": "IconTrendingFour", "module": "src/components/icon/icons/trending-four.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trending-four.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTrendingFour", "declaration": { "name": "IconTrendingFour", "module": "src/components/icon/icons/trending-four.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trending-one.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTrendingOne", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-trending-one", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrendingOne", "declaration": { "name": "IconTrendingOne", "module": "src/components/icon/icons/trending-one.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trending-one.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTrendingOne", "declaration": { "name": "IconTrendingOne", "module": "src/components/icon/icons/trending-one.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trending-three.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTrendingThree", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-trending-three", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrendingThree", "declaration": { "name": "IconTrendingThree", "module": "src/components/icon/icons/trending-three.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trending-three.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTrendingThree", "declaration": { "name": "IconTrendingThree", "module": "src/components/icon/icons/trending-three.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trending-two.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTrendingTwo", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-trending-two", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrendingTwo", "declaration": { "name": "IconTrendingTwo", "module": "src/components/icon/icons/trending-two.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/trending-two.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTrendingTwo", "declaration": { "name": "IconTrendingTwo", "module": "src/components/icon/icons/trending-two.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/triangle-exclamation.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTriangleExclamation", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-triangle-exclamation", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTriangleExclamation", "declaration": { "name": "IconTriangleExclamation", "module": "src/components/icon/icons/triangle-exclamation.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/triangle-exclamation.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTriangleExclamation", "declaration": { "name": "IconTriangleExclamation", "module": "src/components/icon/icons/triangle-exclamation.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/truck.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconTruck", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-truck", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconTruck", "declaration": { "name": "IconTruck", "module": "src/components/icon/icons/truck.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/truck.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconTruck", "declaration": { "name": "IconTruck", "module": "src/components/icon/icons/truck.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/umbrella-security.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconUmbrellaSecurity", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-umbrella-security", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconUmbrellaSecurity", "declaration": { "name": "IconUmbrellaSecurity", "module": "src/components/icon/icons/umbrella-security.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/umbrella-security.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconUmbrellaSecurity", "declaration": { "name": "IconUmbrellaSecurity", "module": "src/components/icon/icons/umbrella-security.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/unlocked.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconUnlocked", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-unlocked", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconUnlocked", "declaration": { "name": "IconUnlocked", "module": "src/components/icon/icons/unlocked.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/unlocked.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconUnlocked", "declaration": { "name": "IconUnlocked", "module": "src/components/icon/icons/unlocked.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/volume-full.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconVolumeFull", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-volume-full", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconVolumeFull", "declaration": { "name": "IconVolumeFull", "module": "src/components/icon/icons/volume-full.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/volume-full.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconVolumeFull", "declaration": { "name": "IconVolumeFull", "module": "src/components/icon/icons/volume-full.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/volume-half.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconVolumeHalf", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-volume-half", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconVolumeHalf", "declaration": { "name": "IconVolumeHalf", "module": "src/components/icon/icons/volume-half.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/volume-half.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconVolumeHalf", "declaration": { "name": "IconVolumeHalf", "module": "src/components/icon/icons/volume-half.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/volume-off.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconVolumeOff", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-volume-off", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconVolumeOff", "declaration": { "name": "IconVolumeOff", "module": "src/components/icon/icons/volume-off.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/volume-off.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconVolumeOff", "declaration": { "name": "IconVolumeOff", "module": "src/components/icon/icons/volume-off.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/wallet.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconWallet", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-wallet", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconWallet", "declaration": { "name": "IconWallet", "module": "src/components/icon/icons/wallet.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/wallet.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconWallet", "declaration": { "name": "IconWallet", "module": "src/components/icon/icons/wallet.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/warning-sign.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconWarningSign", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-warning-sign", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconWarningSign", "declaration": { "name": "IconWarningSign", "module": "src/components/icon/icons/warning-sign.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/warning-sign.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconWarningSign", "declaration": { "name": "IconWarningSign", "module": "src/components/icon/icons/warning-sign.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/wifi-full.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconWifiFull", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-wifi-full", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconWifiFull", "declaration": { "name": "IconWifiFull", "module": "src/components/icon/icons/wifi-full.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/wifi-full.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconWifiFull", "declaration": { "name": "IconWifiFull", "module": "src/components/icon/icons/wifi-full.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/youtube.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconYoutube", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-youtube", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconYoutube", "declaration": { "name": "IconYoutube", "module": "src/components/icon/icons/youtube.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/youtube.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconYoutube", "declaration": { "name": "IconYoutube", "module": "src/components/icon/icons/youtube.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/zap.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconZap", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-zap", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconZap", "declaration": { "name": "IconZap", "module": "src/components/icon/icons/zap.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/zap.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconZap", "declaration": { "name": "IconZap", "module": "src/components/icon/icons/zap.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/zoom-in.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconZoomIn", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-zoom-in", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconZoomIn", "declaration": { "name": "IconZoomIn", "module": "src/components/icon/icons/zoom-in.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/zoom-in.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconZoomIn", "declaration": { "name": "IconZoomIn", "module": "src/components/icon/icons/zoom-in.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/zoom-out.component.ts", "declarations": [ { "kind": "class", "description": "", "name": "IconZoomOut", "superclass": { "name": "GdsIcon", "module": "/src/components/icon/icon" }, "tagName": "gds-icon-zoom-out", "customElement": true, "members": [ { "kind": "field", "name": "margin", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-inline'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-inline` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'margin-block'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `margin-block` property.\nOnly accepts space tokens.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withMarginProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'align-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `align-self` property.\nSupports all valid CSS `align-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'justify-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `justify-self` property.\nSupports all valid CSS `justify-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'place-self'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `place-self` property.\nSupports all valid CSS `place-self` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-column'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-column` property.\nSupports all valid CSS grid-column values.\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-row'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-row` property.\nSupports all valid CSS `grid-row` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "'grid-area'", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `grid-area` property.\nSupports all valid CSS `grid-area` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "flex", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `flex` property.\nSupports all valid CSS `flex` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "order", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `order` property.\nSupports all valid CSS `order` values.", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "withLayoutChildProps", "module": "src/utils/mixins/declarative-layout-mixins.ts" } }, { "kind": "field", "name": "size", "type": { "text": "string | undefined" }, "description": "This property allow you to set the size of the icon with the token and custom values.\nIf not provided, uses the icon's default size.\n\nThe size is a shorthand for setting both width and height at once.", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "attribute": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "attribute": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "attribute": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "color", "type": { "text": "string | undefined" }, "description": "Style Expression Property that controls the `color` property.\nOnly accepts color tokens and an optional transparency value, in the format tokenName/transparency.\n\n```html\n\n```", "category": "Declarative layout / Style expression properties", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "attribute": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "kind": "method", "name": "define", "static": true, "return": { "type": { "text": "void" } }, "description": "Defines the custom element in the custom element registry.\nThis method needs to be called once before the element can be used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "isDefined", "type": { "text": "boolean" }, "static": true, "default": "false", "description": "Whether the element is defined in the custom element registry.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "styleExpressionBaseSelector", "type": { "text": "string" }, "static": true, "default": "':host'", "description": "Style expression properties for this element will use this selector by default.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "semanticVersion", "type": { "text": "string" }, "readonly": true, "default": "'__GDS_SEM_VER__'", "description": "The semantic version of this element. Can be used for troubleshooting to verify the version being used.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "syncFirstRender", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "attribute": "sync-first-render", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "field", "name": "gdsElementName", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "attribute": "gds-element", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchStandardEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "EventInit" } } ], "description": "Dispatches a standard event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "kind": "method", "name": "dispatchCustomEvent", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "options", "default": "{}", "type": { "text": "CustomEventInit" } } ], "description": "Dispatches a custom event with the given name and options.\nA pascal cased version of the event name is also dispatched for compatibility.", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "cssParts": [ { "description": "The icon SVG element.", "name": "icon", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } } ], "attributes": [ { "name": "solid", "type": { "text": "boolean" }, "default": "false", "description": "When set to true, the solid version of the icon is displayed.\nWhen set to false or not provided, the regular version of the icon is displayed.", "fieldName": "solid", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "stroke", "type": { "text": "number | undefined" }, "description": "When set to true, you can apply custom stroke width to the icon.", "fieldName": "stroke", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "level", "type": { "text": "GdsColorLevel" }, "default": "'2'", "description": "The level of the icon is used to resolve the color tokens from the corresponding level.\nCheck the [Color System documentation page](./?path=/docs/style-colors--docs) for more information.\n\nDefault for `gds-icon-*` is level 2.", "fieldName": "level", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "This property allow you to set the accessible label of the icon.\nIf not provided, the icon will be presentational.", "fieldName": "label", "inheritedFrom": { "name": "GdsIcon", "module": "src/components/icon/icon.component.ts" } }, { "name": "gds-element", "type": { "text": "string | undefined" }, "description": "The unscoped name of this element. This attribute is set automatically by the element and is inteded to be read-only.", "readonly": true, "fieldName": "gdsElementName", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "sync-first-render", "type": { "text": "boolean" }, "default": "false", "description": "Force the element to perform a synchronous first render and apply style expression properties in `connectedCallback`.\n\nThis guarantees that the child DOM always remains projected in DOM, since the element will attach the shadowRoot and\nrun the first render pass in the same event loop cycle, and that declarative layout will be applied once slotted DOM\nis projected.\n\nNote: This will cause the first render pass to be blocking. Use sparingly and only when necessary, such as when the\nelement needs to be measured synchronously after being added to the DOM.", "fieldName": "syncFirstRender", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ], "events": [ { "name": "gds-element-disconnected", "type": { "text": "CustomEvent" }, "description": "When the element is disconnected from the DOM", "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "name": "name", "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } }, { "type": { "text": "Event" }, "inheritedFrom": { "name": "GdsElement", "module": "src/gds-element.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IconZoomOut", "declaration": { "name": "IconZoomOut", "module": "src/components/icon/icons/zoom-out.component.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icons/zoom-out.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IconZoomOut", "declaration": { "name": "IconZoomOut", "module": "src/components/icon/icons/zoom-out.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-ai/index.ts", "declarations": [ { "kind": "function", "name": "IconAi", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconAi", "declaration": { "name": "IconAi", "module": "src/generated/react/icons/icon-ai/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-airplane-up/index.ts", "declarations": [ { "kind": "function", "name": "IconAirplaneUp", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconAirplaneUp", "declaration": { "name": "IconAirplaneUp", "module": "src/generated/react/icons/icon-airplane-up/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-archive/index.ts", "declarations": [ { "kind": "function", "name": "IconArchive", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArchive", "declaration": { "name": "IconArchive", "module": "src/generated/react/icons/icon-archive/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow/index.ts", "declarations": [ { "kind": "function", "name": "IconArrow", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrow", "declaration": { "name": "IconArrow", "module": "src/generated/react/icons/icon-arrow/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-bottom-top/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowBottomTop", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowBottomTop", "declaration": { "name": "IconArrowBottomTop", "module": "src/generated/react/icons/icon-arrow-bottom-top/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-box-left-alt/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowBoxLeftAlt", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowBoxLeftAlt", "declaration": { "name": "IconArrowBoxLeftAlt", "module": "src/generated/react/icons/icon-arrow-box-left-alt/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-box-left/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowBoxLeft", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowBoxLeft", "declaration": { "name": "IconArrowBoxLeft", "module": "src/generated/react/icons/icon-arrow-box-left/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-box-right/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowBoxRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowBoxRight", "declaration": { "name": "IconArrowBoxRight", "module": "src/generated/react/icons/icon-arrow-box-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-down/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowDown", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowDown", "declaration": { "name": "IconArrowDown", "module": "src/generated/react/icons/icon-arrow-down/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-inbox/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowInbox", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowInbox", "declaration": { "name": "IconArrowInbox", "module": "src/generated/react/icons/icon-arrow-inbox/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-left/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowLeft", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowLeft", "declaration": { "name": "IconArrowLeft", "module": "src/generated/react/icons/icon-arrow-left/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-left-right/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowLeftRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowLeftRight", "declaration": { "name": "IconArrowLeftRight", "module": "src/generated/react/icons/icon-arrow-left-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-out-of-box/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowOutOfBox", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowOutOfBox", "declaration": { "name": "IconArrowOutOfBox", "module": "src/generated/react/icons/icon-arrow-out-of-box/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-right/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRight", "declaration": { "name": "IconArrowRight", "module": "src/generated/react/icons/icon-arrow-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-right-circle/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowRightCircle", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRightCircle", "declaration": { "name": "IconArrowRightCircle", "module": "src/generated/react/icons/icon-arrow-right-circle/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-right-up-circle/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowRightUpCircle", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRightUpCircle", "declaration": { "name": "IconArrowRightUpCircle", "module": "src/generated/react/icons/icon-arrow-right-up-circle/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-right-down-circle/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowRightDownCircle", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRightDownCircle", "declaration": { "name": "IconArrowRightDownCircle", "module": "src/generated/react/icons/icon-arrow-right-down-circle/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-rotate-clockwise/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowRotateClockwise", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRotateClockwise", "declaration": { "name": "IconArrowRotateClockwise", "module": "src/generated/react/icons/icon-arrow-rotate-clockwise/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-rotate-counter-clockwise/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowRotateCounterClockwise", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRotateCounterClockwise", "declaration": { "name": "IconArrowRotateCounterClockwise", "module": "src/generated/react/icons/icon-arrow-rotate-counter-clockwise/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-rotate-left-right/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowRotateLeftRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRotateLeftRight", "declaration": { "name": "IconArrowRotateLeftRight", "module": "src/generated/react/icons/icon-arrow-rotate-left-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-rotate-right-left/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowRotateRightLeft", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowRotateRightLeft", "declaration": { "name": "IconArrowRotateRightLeft", "module": "src/generated/react/icons/icon-arrow-rotate-right-left/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-share-left/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowShareLeft", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowShareLeft", "declaration": { "name": "IconArrowShareLeft", "module": "src/generated/react/icons/icon-arrow-share-left/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-share-right/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowShareRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowShareRight", "declaration": { "name": "IconArrowShareRight", "module": "src/generated/react/icons/icon-arrow-share-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-split/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowSplit", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowSplit", "declaration": { "name": "IconArrowSplit", "module": "src/generated/react/icons/icon-arrow-split/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-up/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowUp", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowUp", "declaration": { "name": "IconArrowUp", "module": "src/generated/react/icons/icon-arrow-up/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-wall-down/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowWallDown", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowWallDown", "declaration": { "name": "IconArrowWallDown", "module": "src/generated/react/icons/icon-arrow-wall-down/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-wall-left/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowWallLeft", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowWallLeft", "declaration": { "name": "IconArrowWallLeft", "module": "src/generated/react/icons/icon-arrow-wall-left/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-wall-right/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowWallRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowWallRight", "declaration": { "name": "IconArrowWallRight", "module": "src/generated/react/icons/icon-arrow-wall-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-arrow-wall-up/index.ts", "declarations": [ { "kind": "function", "name": "IconArrowWallUp", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconArrowWallUp", "declaration": { "name": "IconArrowWallUp", "module": "src/generated/react/icons/icon-arrow-wall-up/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-asterisk/index.ts", "declarations": [ { "kind": "function", "name": "IconAsterisk", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconAsterisk", "declaration": { "name": "IconAsterisk", "module": "src/generated/react/icons/icon-asterisk/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-at/index.ts", "declarations": [ { "kind": "function", "name": "IconAt", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconAt", "declaration": { "name": "IconAt", "module": "src/generated/react/icons/icon-at/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-back/index.ts", "declarations": [ { "kind": "function", "name": "IconBack", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBack", "declaration": { "name": "IconBack", "module": "src/generated/react/icons/icon-back/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-backward/index.ts", "declarations": [ { "kind": "function", "name": "IconBackward", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBackward", "declaration": { "name": "IconBackward", "module": "src/generated/react/icons/icon-backward/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bag/index.ts", "declarations": [ { "kind": "function", "name": "IconBag", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBag", "declaration": { "name": "IconBag", "module": "src/generated/react/icons/icon-bag/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bank/index.ts", "declarations": [ { "kind": "function", "name": "IconBank", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBank", "declaration": { "name": "IconBank", "module": "src/generated/react/icons/icon-bank/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-banknote/index.ts", "declarations": [ { "kind": "function", "name": "IconBanknote", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBanknote", "declaration": { "name": "IconBanknote", "module": "src/generated/react/icons/icon-banknote/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-banknote-2/index.ts", "declarations": [ { "kind": "function", "name": "IconBanknote2", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBanknote2", "declaration": { "name": "IconBanknote2", "module": "src/generated/react/icons/icon-banknote-2/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-barcode/index.ts", "declarations": [ { "kind": "function", "name": "IconBarcode", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBarcode", "declaration": { "name": "IconBarcode", "module": "src/generated/react/icons/icon-barcode/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bars-three/index.ts", "declarations": [ { "kind": "function", "name": "IconBarsThree", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBarsThree", "declaration": { "name": "IconBarsThree", "module": "src/generated/react/icons/icon-bars-three/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bars-two/index.ts", "declarations": [ { "kind": "function", "name": "IconBarsTwo", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBarsTwo", "declaration": { "name": "IconBarsTwo", "module": "src/generated/react/icons/icon-bars-two/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-basket/index.ts", "declarations": [ { "kind": "function", "name": "IconBasket", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBasket", "declaration": { "name": "IconBasket", "module": "src/generated/react/icons/icon-basket/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-battery-loading/index.ts", "declarations": [ { "kind": "function", "name": "IconBatteryLoading", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBatteryLoading", "declaration": { "name": "IconBatteryLoading", "module": "src/generated/react/icons/icon-battery-loading/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bell/index.ts", "declarations": [ { "kind": "function", "name": "IconBell", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBell", "declaration": { "name": "IconBell", "module": "src/generated/react/icons/icon-bell/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-block/index.ts", "declarations": [ { "kind": "function", "name": "IconBlock", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBlock", "declaration": { "name": "IconBlock", "module": "src/generated/react/icons/icon-block/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bookmark/index.ts", "declarations": [ { "kind": "function", "name": "IconBookmark", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBookmark", "declaration": { "name": "IconBookmark", "module": "src/generated/react/icons/icon-bookmark/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bookmark-check/index.ts", "declarations": [ { "kind": "function", "name": "IconBookmarkCheck", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBookmarkCheck", "declaration": { "name": "IconBookmarkCheck", "module": "src/generated/react/icons/icon-bookmark-check/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bookmark-delete/index.ts", "declarations": [ { "kind": "function", "name": "IconBookmarkDelete", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBookmarkDelete", "declaration": { "name": "IconBookmarkDelete", "module": "src/generated/react/icons/icon-bookmark-delete/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-book/index.ts", "declarations": [ { "kind": "function", "name": "IconBook", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBook", "declaration": { "name": "IconBook", "module": "src/generated/react/icons/icon-book/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bookmark-plus/index.ts", "declarations": [ { "kind": "function", "name": "IconBookmarkPlus", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBookmarkPlus", "declaration": { "name": "IconBookmarkPlus", "module": "src/generated/react/icons/icon-bookmark-plus/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bookmark-remove/index.ts", "declarations": [ { "kind": "function", "name": "IconBookmarkRemove", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBookmarkRemove", "declaration": { "name": "IconBookmarkRemove", "module": "src/generated/react/icons/icon-bookmark-remove/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-books/index.ts", "declarations": [ { "kind": "function", "name": "IconBooks", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBooks", "declaration": { "name": "IconBooks", "module": "src/generated/react/icons/icon-books/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-app-store/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandAppStore", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandAppStore", "declaration": { "name": "IconBrandAppStore", "module": "src/generated/react/icons/icon-brand-app-store/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-apple-music/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandAppleMusic", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandAppleMusic", "declaration": { "name": "IconBrandAppleMusic", "module": "src/generated/react/icons/icon-brand-apple-music/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-bankid/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandBankid", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandBankid", "declaration": { "name": "IconBrandBankid", "module": "src/generated/react/icons/icon-brand-bankid/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-facebook/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandFacebook", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandFacebook", "declaration": { "name": "IconBrandFacebook", "module": "src/generated/react/icons/icon-brand-facebook/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-chrome/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandChrome", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandChrome", "declaration": { "name": "IconBrandChrome", "module": "src/generated/react/icons/icon-brand-chrome/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-figma/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandFigma", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandFigma", "declaration": { "name": "IconBrandFigma", "module": "src/generated/react/icons/icon-brand-figma/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-firefox/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandFirefox", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandFirefox", "declaration": { "name": "IconBrandFirefox", "module": "src/generated/react/icons/icon-brand-firefox/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-github/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandGithub", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandGithub", "declaration": { "name": "IconBrandGithub", "module": "src/generated/react/icons/icon-brand-github/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-green/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandGreen", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandGreen", "declaration": { "name": "IconBrandGreen", "module": "src/generated/react/icons/icon-brand-green/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-instagram/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandInstagram", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandInstagram", "declaration": { "name": "IconBrandInstagram", "module": "src/generated/react/icons/icon-brand-instagram/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-linkedin/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandLinkedin", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandLinkedin", "declaration": { "name": "IconBrandLinkedin", "module": "src/generated/react/icons/icon-brand-linkedin/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-play-store/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandPlayStore", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandPlayStore", "declaration": { "name": "IconBrandPlayStore", "module": "src/generated/react/icons/icon-brand-play-store/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-rss-feed/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandRssFeed", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandRssFeed", "declaration": { "name": "IconBrandRssFeed", "module": "src/generated/react/icons/icon-brand-rss-feed/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-seb/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandSeb", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandSeb", "declaration": { "name": "IconBrandSeb", "module": "src/generated/react/icons/icon-brand-seb/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-spotify/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandSpotify", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandSpotify", "declaration": { "name": "IconBrandSpotify", "module": "src/generated/react/icons/icon-brand-spotify/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-storybook/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandStorybook", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandStorybook", "declaration": { "name": "IconBrandStorybook", "module": "src/generated/react/icons/icon-brand-storybook/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-swish-word/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandSwishWord", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandSwishWord", "declaration": { "name": "IconBrandSwishWord", "module": "src/generated/react/icons/icon-brand-swish-word/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brand-x/index.ts", "declarations": [ { "kind": "function", "name": "IconBrandX", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrandX", "declaration": { "name": "IconBrandX", "module": "src/generated/react/icons/icon-brand-x/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-brush/index.ts", "declarations": [ { "kind": "function", "name": "IconBrush", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBrush", "declaration": { "name": "IconBrush", "module": "src/generated/react/icons/icon-brush/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bubble-annotation/index.ts", "declarations": [ { "kind": "function", "name": "IconBubbleAnnotation", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBubbleAnnotation", "declaration": { "name": "IconBubbleAnnotation", "module": "src/generated/react/icons/icon-bubble-annotation/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bubbles/index.ts", "declarations": [ { "kind": "function", "name": "IconBubbles", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBubbles", "declaration": { "name": "IconBubbles", "module": "src/generated/react/icons/icon-bubbles/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-buildings/index.ts", "declarations": [ { "kind": "function", "name": "IconBuildings", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBuildings", "declaration": { "name": "IconBuildings", "module": "src/generated/react/icons/icon-buildings/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-calculator/index.ts", "declarations": [ { "kind": "function", "name": "IconCalculator", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCalculator", "declaration": { "name": "IconCalculator", "module": "src/generated/react/icons/icon-calculator/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-bullet-list/index.ts", "declarations": [ { "kind": "function", "name": "IconBulletList", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconBulletList", "declaration": { "name": "IconBulletList", "module": "src/generated/react/icons/icon-bullet-list/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-calendar/index.ts", "declarations": [ { "kind": "function", "name": "IconCalendar", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCalendar", "declaration": { "name": "IconCalendar", "module": "src/generated/react/icons/icon-calendar/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-calender-add/index.ts", "declarations": [ { "kind": "function", "name": "IconCalenderAdd", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCalenderAdd", "declaration": { "name": "IconCalenderAdd", "module": "src/generated/react/icons/icon-calender-add/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-calendar-check/index.ts", "declarations": [ { "kind": "function", "name": "IconCalendarCheck", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCalendarCheck", "declaration": { "name": "IconCalendarCheck", "module": "src/generated/react/icons/icon-calendar-check/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-call/index.ts", "declarations": [ { "kind": "function", "name": "IconCall", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCall", "declaration": { "name": "IconCall", "module": "src/generated/react/icons/icon-call/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-car/index.ts", "declarations": [ { "kind": "function", "name": "IconCar", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCar", "declaration": { "name": "IconCar", "module": "src/generated/react/icons/icon-car/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-carussel/index.ts", "declarations": [ { "kind": "function", "name": "IconCarussel", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCarussel", "declaration": { "name": "IconCarussel", "module": "src/generated/react/icons/icon-carussel/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chain-link/index.ts", "declarations": [ { "kind": "function", "name": "IconChainLink", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChainLink", "declaration": { "name": "IconChainLink", "module": "src/generated/react/icons/icon-chain-link/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chain-link-broken/index.ts", "declarations": [ { "kind": "function", "name": "IconChainLinkBroken", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChainLinkBroken", "declaration": { "name": "IconChainLinkBroken", "module": "src/generated/react/icons/icon-chain-link-broken/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chart-two/index.ts", "declarations": [ { "kind": "function", "name": "IconChartTwo", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChartTwo", "declaration": { "name": "IconChartTwo", "module": "src/generated/react/icons/icon-chart-two/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-checklist/index.ts", "declarations": [ { "kind": "function", "name": "IconChecklist", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChecklist", "declaration": { "name": "IconChecklist", "module": "src/generated/react/icons/icon-checklist/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-checkmark/index.ts", "declarations": [ { "kind": "function", "name": "IconCheckmark", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCheckmark", "declaration": { "name": "IconCheckmark", "module": "src/generated/react/icons/icon-checkmark/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-bottom/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronBottom", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronBottom", "declaration": { "name": "IconChevronBottom", "module": "src/generated/react/icons/icon-chevron-bottom/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-double-down/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronDoubleDown", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronDoubleDown", "declaration": { "name": "IconChevronDoubleDown", "module": "src/generated/react/icons/icon-chevron-double-down/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-double-left/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronDoubleLeft", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronDoubleLeft", "declaration": { "name": "IconChevronDoubleLeft", "module": "src/generated/react/icons/icon-chevron-double-left/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-double-right/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronDoubleRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronDoubleRight", "declaration": { "name": "IconChevronDoubleRight", "module": "src/generated/react/icons/icon-chevron-double-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-double-up/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronDoubleUp", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronDoubleUp", "declaration": { "name": "IconChevronDoubleUp", "module": "src/generated/react/icons/icon-chevron-double-up/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-down-small/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronDownSmall", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronDownSmall", "declaration": { "name": "IconChevronDownSmall", "module": "src/generated/react/icons/icon-chevron-down-small/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-grabber-vertical/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronGrabberVertical", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronGrabberVertical", "declaration": { "name": "IconChevronGrabberVertical", "module": "src/generated/react/icons/icon-chevron-grabber-vertical/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-grabber-vertical-reversed/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronGrabberVerticalReversed", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType<\n typeof getReactComponent\n >\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronGrabberVerticalReversed", "declaration": { "name": "IconChevronGrabberVerticalReversed", "module": "src/generated/react/icons/icon-chevron-grabber-vertical-reversed/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-left/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronLeft", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronLeft", "declaration": { "name": "IconChevronLeft", "module": "src/generated/react/icons/icon-chevron-left/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-left-small/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronLeftSmall", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronLeftSmall", "declaration": { "name": "IconChevronLeftSmall", "module": "src/generated/react/icons/icon-chevron-left-small/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-right/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronRight", "declaration": { "name": "IconChevronRight", "module": "src/generated/react/icons/icon-chevron-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-right-small/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronRightSmall", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronRightSmall", "declaration": { "name": "IconChevronRightSmall", "module": "src/generated/react/icons/icon-chevron-right-small/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-top/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronTop", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronTop", "declaration": { "name": "IconChevronTop", "module": "src/generated/react/icons/icon-chevron-top/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-chevron-top-small/index.ts", "declarations": [ { "kind": "function", "name": "IconChevronTopSmall", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconChevronTopSmall", "declaration": { "name": "IconChevronTopSmall", "module": "src/generated/react/icons/icon-chevron-top-small/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-circle-ban/index.ts", "declarations": [ { "kind": "function", "name": "IconCircleBan", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleBan", "declaration": { "name": "IconCircleBan", "module": "src/generated/react/icons/icon-circle-ban/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-circle-check/index.ts", "declarations": [ { "kind": "function", "name": "IconCircleCheck", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleCheck", "declaration": { "name": "IconCircleCheck", "module": "src/generated/react/icons/icon-circle-check/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-circle-dots/index.ts", "declarations": [ { "kind": "function", "name": "IconCircleDots", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleDots", "declaration": { "name": "IconCircleDots", "module": "src/generated/react/icons/icon-circle-dots/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-circle-info/index.ts", "declarations": [ { "kind": "function", "name": "IconCircleInfo", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleInfo", "declaration": { "name": "IconCircleInfo", "module": "src/generated/react/icons/icon-circle-info/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-circle-minus/index.ts", "declarations": [ { "kind": "function", "name": "IconCircleMinus", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleMinus", "declaration": { "name": "IconCircleMinus", "module": "src/generated/react/icons/icon-circle-minus/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-circle-placeholder-on/index.ts", "declarations": [ { "kind": "function", "name": "IconCirclePlaceholderOn", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCirclePlaceholderOn", "declaration": { "name": "IconCirclePlaceholderOn", "module": "src/generated/react/icons/icon-circle-placeholder-on/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-circle-plus/index.ts", "declarations": [ { "kind": "function", "name": "IconCirclePlus", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCirclePlus", "declaration": { "name": "IconCirclePlus", "module": "src/generated/react/icons/icon-circle-plus/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-circle-questionmark/index.ts", "declarations": [ { "kind": "function", "name": "IconCircleQuestionmark", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleQuestionmark", "declaration": { "name": "IconCircleQuestionmark", "module": "src/generated/react/icons/icon-circle-questionmark/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-circle-x/index.ts", "declarations": [ { "kind": "function", "name": "IconCircleX", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCircleX", "declaration": { "name": "IconCircleX", "module": "src/generated/react/icons/icon-circle-x/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-circles-three/index.ts", "declarations": [ { "kind": "function", "name": "IconCirclesThree", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCirclesThree", "declaration": { "name": "IconCirclesThree", "module": "src/generated/react/icons/icon-circles-three/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-clock/index.ts", "declarations": [ { "kind": "function", "name": "IconClock", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconClock", "declaration": { "name": "IconClock", "module": "src/generated/react/icons/icon-clock/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-cloud-download/index.ts", "declarations": [ { "kind": "function", "name": "IconCloudDownload", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCloudDownload", "declaration": { "name": "IconCloudDownload", "module": "src/generated/react/icons/icon-cloud-download/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-cloud-upload/index.ts", "declarations": [ { "kind": "function", "name": "IconCloudUpload", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCloudUpload", "declaration": { "name": "IconCloudUpload", "module": "src/generated/react/icons/icon-cloud-upload/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-cloudy-sun/index.ts", "declarations": [ { "kind": "function", "name": "IconCloudySun", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCloudySun", "declaration": { "name": "IconCloudySun", "module": "src/generated/react/icons/icon-cloudy-sun/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-code/index.ts", "declarations": [ { "kind": "function", "name": "IconCode", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCode", "declaration": { "name": "IconCode", "module": "src/generated/react/icons/icon-code/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-code-brackets/index.ts", "declarations": [ { "kind": "function", "name": "IconCodeBrackets", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCodeBrackets", "declaration": { "name": "IconCodeBrackets", "module": "src/generated/react/icons/icon-code-brackets/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-compass-round/index.ts", "declarations": [ { "kind": "function", "name": "IconCompassRound", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCompassRound", "declaration": { "name": "IconCompassRound", "module": "src/generated/react/icons/icon-compass-round/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-cookies/index.ts", "declarations": [ { "kind": "function", "name": "IconCookies", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCookies", "declaration": { "name": "IconCookies", "module": "src/generated/react/icons/icon-cookies/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-copy/index.ts", "declarations": [ { "kind": "function", "name": "IconCopy", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCopy", "declaration": { "name": "IconCopy", "module": "src/generated/react/icons/icon-copy/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-credit-card/index.ts", "declarations": [ { "kind": "function", "name": "IconCreditCard", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCreditCard", "declaration": { "name": "IconCreditCard", "module": "src/generated/react/icons/icon-credit-card/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-credit-card-add/index.ts", "declarations": [ { "kind": "function", "name": "IconCreditCardAdd", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCreditCardAdd", "declaration": { "name": "IconCreditCardAdd", "module": "src/generated/react/icons/icon-credit-card-add/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-cross-large/index.ts", "declarations": [ { "kind": "function", "name": "IconCrossLarge", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCrossLarge", "declaration": { "name": "IconCrossLarge", "module": "src/generated/react/icons/icon-cross-large/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-cross-small/index.ts", "declarations": [ { "kind": "function", "name": "IconCrossSmall", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCrossSmall", "declaration": { "name": "IconCrossSmall", "module": "src/generated/react/icons/icon-cross-small/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-cup-hot/index.ts", "declarations": [ { "kind": "function", "name": "IconCupHot", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCupHot", "declaration": { "name": "IconCupHot", "module": "src/generated/react/icons/icon-cup-hot/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-cursor/index.ts", "declarations": [ { "kind": "function", "name": "IconCursor", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconCursor", "declaration": { "name": "IconCursor", "module": "src/generated/react/icons/icon-cursor/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-details/index.ts", "declarations": [ { "kind": "function", "name": "GdsIconDetails", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "GdsIconDetails", "declaration": { "name": "GdsIconDetails", "module": "src/generated/react/icons/icon-details/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-devices/index.ts", "declarations": [ { "kind": "function", "name": "IconDevices", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconDevices", "declaration": { "name": "IconDevices", "module": "src/generated/react/icons/icon-devices/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-direction/index.ts", "declarations": [ { "kind": "function", "name": "IconDirection", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconDirection", "declaration": { "name": "IconDirection", "module": "src/generated/react/icons/icon-direction/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-dollar/index.ts", "declarations": [ { "kind": "function", "name": "IconDollar", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconDollar", "declaration": { "name": "IconDollar", "module": "src/generated/react/icons/icon-dollar/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-dot-grid-one-horizontal/index.ts", "declarations": [ { "kind": "function", "name": "IconDotGridOneHorizontal", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconDotGridOneHorizontal", "declaration": { "name": "IconDotGridOneHorizontal", "module": "src/generated/react/icons/icon-dot-grid-one-horizontal/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-dot-grid-one-vertical/index.ts", "declarations": [ { "kind": "function", "name": "IconDotGridOneVertical", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconDotGridOneVertical", "declaration": { "name": "IconDotGridOneVertical", "module": "src/generated/react/icons/icon-dot-grid-one-vertical/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-dot-grid-three/index.ts", "declarations": [ { "kind": "function", "name": "IconDotGridThree", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconDotGridThree", "declaration": { "name": "IconDotGridThree", "module": "src/generated/react/icons/icon-dot-grid-three/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-dot-grid-two/index.ts", "declarations": [ { "kind": "function", "name": "IconDotGridTwo", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconDotGridTwo", "declaration": { "name": "IconDotGridTwo", "module": "src/generated/react/icons/icon-dot-grid-two/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-email/index.ts", "declarations": [ { "kind": "function", "name": "IconEmail", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmail", "declaration": { "name": "IconEmail", "module": "src/generated/react/icons/icon-email/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-emoji-angry/index.ts", "declarations": [ { "kind": "function", "name": "IconEmojiAngry", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmojiAngry", "declaration": { "name": "IconEmojiAngry", "module": "src/generated/react/icons/icon-emoji-angry/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-emoji-neutral/index.ts", "declarations": [ { "kind": "function", "name": "IconEmojiNeutral", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmojiNeutral", "declaration": { "name": "IconEmojiNeutral", "module": "src/generated/react/icons/icon-emoji-neutral/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-emoji-sad/index.ts", "declarations": [ { "kind": "function", "name": "IconEmojiSad", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmojiSad", "declaration": { "name": "IconEmojiSad", "module": "src/generated/react/icons/icon-emoji-sad/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-emoji-smile/index.ts", "declarations": [ { "kind": "function", "name": "IconEmojiSmile", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmojiSmile", "declaration": { "name": "IconEmojiSmile", "module": "src/generated/react/icons/icon-emoji-smile/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-emoji-smiley/index.ts", "declarations": [ { "kind": "function", "name": "IconEmojiSmiley", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconEmojiSmiley", "declaration": { "name": "IconEmojiSmiley", "module": "src/generated/react/icons/icon-emoji-smiley/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-euro/index.ts", "declarations": [ { "kind": "function", "name": "IconEuro", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconEuro", "declaration": { "name": "IconEuro", "module": "src/generated/react/icons/icon-euro/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-expand/index.ts", "declarations": [ { "kind": "function", "name": "IconExpand", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconExpand", "declaration": { "name": "IconExpand", "module": "src/generated/react/icons/icon-expand/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-eye-open/index.ts", "declarations": [ { "kind": "function", "name": "IconEyeOpen", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconEyeOpen", "declaration": { "name": "IconEyeOpen", "module": "src/generated/react/icons/icon-eye-open/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-eye-slash/index.ts", "declarations": [ { "kind": "function", "name": "IconEyeSlash", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconEyeSlash", "declaration": { "name": "IconEyeSlash", "module": "src/generated/react/icons/icon-eye-slash/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-fashion/index.ts", "declarations": [ { "kind": "function", "name": "IconFashion", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFashion", "declaration": { "name": "IconFashion", "module": "src/generated/react/icons/icon-fashion/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-fast-forward/index.ts", "declarations": [ { "kind": "function", "name": "IconFastForward", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFastForward", "declaration": { "name": "IconFastForward", "module": "src/generated/react/icons/icon-fast-forward/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-file-bend/index.ts", "declarations": [ { "kind": "function", "name": "IconFileBend", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFileBend", "declaration": { "name": "IconFileBend", "module": "src/generated/react/icons/icon-file-bend/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-file-chart/index.ts", "declarations": [ { "kind": "function", "name": "IconFileChart", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFileChart", "declaration": { "name": "IconFileChart", "module": "src/generated/react/icons/icon-file-chart/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-file-text/index.ts", "declarations": [ { "kind": "function", "name": "IconFileText", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFileText", "declaration": { "name": "IconFileText", "module": "src/generated/react/icons/icon-file-text/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-files/index.ts", "declarations": [ { "kind": "function", "name": "IconFiles", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFiles", "declaration": { "name": "IconFiles", "module": "src/generated/react/icons/icon-files/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-filter/index.ts", "declarations": [ { "kind": "function", "name": "IconFilter", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFilter", "declaration": { "name": "IconFilter", "module": "src/generated/react/icons/icon-filter/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-flag/index.ts", "declarations": [ { "kind": "function", "name": "IconFlag", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFlag", "declaration": { "name": "IconFlag", "module": "src/generated/react/icons/icon-flag/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-floppy-disk/index.ts", "declarations": [ { "kind": "function", "name": "IconFloppyDisk", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFloppyDisk", "declaration": { "name": "IconFloppyDisk", "module": "src/generated/react/icons/icon-floppy-disk/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-focus/index.ts", "declarations": [ { "kind": "function", "name": "IconFocus", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFocus", "declaration": { "name": "IconFocus", "module": "src/generated/react/icons/icon-focus/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-folder/index.ts", "declarations": [ { "kind": "function", "name": "IconFolder", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFolder", "declaration": { "name": "IconFolder", "module": "src/generated/react/icons/icon-folder/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-folder-add-right/index.ts", "declarations": [ { "kind": "function", "name": "IconFolderAddRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFolderAddRight", "declaration": { "name": "IconFolderAddRight", "module": "src/generated/react/icons/icon-folder-add-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-fullscreen/index.ts", "declarations": [ { "kind": "function", "name": "IconFullscreen", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconFullscreen", "declaration": { "name": "IconFullscreen", "module": "src/generated/react/icons/icon-fullscreen/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-gift/index.ts", "declarations": [ { "kind": "function", "name": "IconGift", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconGift", "declaration": { "name": "IconGift", "module": "src/generated/react/icons/icon-gift/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-globus/index.ts", "declarations": [ { "kind": "function", "name": "IconGlobus", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconGlobus", "declaration": { "name": "IconGlobus", "module": "src/generated/react/icons/icon-globus/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-graduate-cap/index.ts", "declarations": [ { "kind": "function", "name": "IconGraduateCap", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconGraduateCap", "declaration": { "name": "IconGraduateCap", "module": "src/generated/react/icons/icon-graduate-cap/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-green-power/index.ts", "declarations": [ { "kind": "function", "name": "IconGreenPower", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconGreenPower", "declaration": { "name": "IconGreenPower", "module": "src/generated/react/icons/icon-green-power/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-group/index.ts", "declarations": [ { "kind": "function", "name": "IconGroup", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconGroup", "declaration": { "name": "IconGroup", "module": "src/generated/react/icons/icon-group/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-growth/index.ts", "declarations": [ { "kind": "function", "name": "IconGrowth", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconGrowth", "declaration": { "name": "IconGrowth", "module": "src/generated/react/icons/icon-growth/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-headphones/index.ts", "declarations": [ { "kind": "function", "name": "IconHeadphones", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconHeadphones", "declaration": { "name": "IconHeadphones", "module": "src/generated/react/icons/icon-headphones/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-heart/index.ts", "declarations": [ { "kind": "function", "name": "IconHeart", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconHeart", "declaration": { "name": "IconHeart", "module": "src/generated/react/icons/icon-heart/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-heart-beat/index.ts", "declarations": [ { "kind": "function", "name": "IconHeartBeat", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconHeartBeat", "declaration": { "name": "IconHeartBeat", "module": "src/generated/react/icons/icon-heart-beat/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-history/index.ts", "declarations": [ { "kind": "function", "name": "IconHistory", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconHistory", "declaration": { "name": "IconHistory", "module": "src/generated/react/icons/icon-history/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-home-energy-one/index.ts", "declarations": [ { "kind": "function", "name": "IconHomeEnergyOne", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconHomeEnergyOne", "declaration": { "name": "IconHomeEnergyOne", "module": "src/generated/react/icons/icon-home-energy-one/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-home-energy-two/index.ts", "declarations": [ { "kind": "function", "name": "IconHomeEnergyTwo", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconHomeEnergyTwo", "declaration": { "name": "IconHomeEnergyTwo", "module": "src/generated/react/icons/icon-home-energy-two/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-home-open/index.ts", "declarations": [ { "kind": "function", "name": "IconHomeOpen", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconHomeOpen", "declaration": { "name": "IconHomeOpen", "module": "src/generated/react/icons/icon-home-open/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-home-roof/index.ts", "declarations": [ { "kind": "function", "name": "IconHomeRoof", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconHomeRoof", "declaration": { "name": "IconHomeRoof", "module": "src/generated/react/icons/icon-home-roof/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-horizontal-alignment-bottom/index.ts", "declarations": [ { "kind": "function", "name": "IconHorizontalAlignmentBottom", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconHorizontalAlignmentBottom", "declaration": { "name": "IconHorizontalAlignmentBottom", "module": "src/generated/react/icons/icon-horizontal-alignment-bottom/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-hourglass/index.ts", "declarations": [ { "kind": "function", "name": "IconHourglass", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconHourglass", "declaration": { "name": "IconHourglass", "module": "src/generated/react/icons/icon-hourglass/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-images/index.ts", "declarations": [ { "kind": "function", "name": "IconImages", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconImages", "declaration": { "name": "IconImages", "module": "src/generated/react/icons/icon-images/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-inbox-empty/index.ts", "declarations": [ { "kind": "function", "name": "IconInboxEmpty", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconInboxEmpty", "declaration": { "name": "IconInboxEmpty", "module": "src/generated/react/icons/icon-inbox-empty/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-industry/index.ts", "declarations": [ { "kind": "function", "name": "IconIndustry", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconIndustry", "declaration": { "name": "IconIndustry", "module": "src/generated/react/icons/icon-industry/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-jpg/index.ts", "declarations": [ { "kind": "function", "name": "IconJpg", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconJpg", "declaration": { "name": "IconJpg", "module": "src/generated/react/icons/icon-jpg/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-key/index.ts", "declarations": [ { "kind": "function", "name": "IconKey", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconKey", "declaration": { "name": "IconKey", "module": "src/generated/react/icons/icon-key/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-knife-spoon/index.ts", "declarations": [ { "kind": "function", "name": "IconKnifeSpoon", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconKnifeSpoon", "declaration": { "name": "IconKnifeSpoon", "module": "src/generated/react/icons/icon-knife-spoon/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-lab/index.ts", "declarations": [ { "kind": "function", "name": "IconLab", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconLab", "declaration": { "name": "IconLab", "module": "src/generated/react/icons/icon-lab/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-law/index.ts", "declarations": [ { "kind": "function", "name": "IconLaw", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconLaw", "declaration": { "name": "IconLaw", "module": "src/generated/react/icons/icon-law/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-leisure/index.ts", "declarations": [ { "kind": "function", "name": "IconLeisure", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconLeisure", "declaration": { "name": "IconLeisure", "module": "src/generated/react/icons/icon-leisure/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-light-bulb-simple/index.ts", "declarations": [ { "kind": "function", "name": "IconLightBulbSimple", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconLightBulbSimple", "declaration": { "name": "IconLightBulbSimple", "module": "src/generated/react/icons/icon-light-bulb-simple/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-lightning/index.ts", "declarations": [ { "kind": "function", "name": "IconLightning", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconLightning", "declaration": { "name": "IconLightning", "module": "src/generated/react/icons/icon-lightning/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-line-chart-four/index.ts", "declarations": [ { "kind": "function", "name": "IconLineChartFour", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconLineChartFour", "declaration": { "name": "IconLineChartFour", "module": "src/generated/react/icons/icon-line-chart-four/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-line-chart-one/index.ts", "declarations": [ { "kind": "function", "name": "IconLineChartOne", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconLineChartOne", "declaration": { "name": "IconLineChartOne", "module": "src/generated/react/icons/icon-line-chart-one/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-line-chart-three/index.ts", "declarations": [ { "kind": "function", "name": "IconLineChartThree", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconLineChartThree", "declaration": { "name": "IconLineChartThree", "module": "src/generated/react/icons/icon-line-chart-three/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-line-chart-two/index.ts", "declarations": [ { "kind": "function", "name": "IconLineChartTwo", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconLineChartTwo", "declaration": { "name": "IconLineChartTwo", "module": "src/generated/react/icons/icon-line-chart-two/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-lock/index.ts", "declarations": [ { "kind": "function", "name": "IconLock", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconLock", "declaration": { "name": "IconLock", "module": "src/generated/react/icons/icon-lock/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-macbook-air/index.ts", "declarations": [ { "kind": "function", "name": "IconMacbookAir", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMacbookAir", "declaration": { "name": "IconMacbookAir", "module": "src/generated/react/icons/icon-macbook-air/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-magnifying-glass/index.ts", "declarations": [ { "kind": "function", "name": "IconMagnifyingGlass", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMagnifyingGlass", "declaration": { "name": "IconMagnifyingGlass", "module": "src/generated/react/icons/icon-magnifying-glass/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-map-pin/index.ts", "declarations": [ { "kind": "function", "name": "IconMapPin", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMapPin", "declaration": { "name": "IconMapPin", "module": "src/generated/react/icons/icon-map-pin/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-megaphone/index.ts", "declarations": [ { "kind": "function", "name": "IconMegaphone", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMegaphone", "declaration": { "name": "IconMegaphone", "module": "src/generated/react/icons/icon-megaphone/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-menu-sidebar/index.ts", "declarations": [ { "kind": "function", "name": "IconMenuSidebar", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMenuSidebar", "declaration": { "name": "IconMenuSidebar", "module": "src/generated/react/icons/icon-menu-sidebar/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-mic-off/index.ts", "declarations": [ { "kind": "function", "name": "IconMicOff", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMicOff", "declaration": { "name": "IconMicOff", "module": "src/generated/react/icons/icon-mic-off/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-mic-on/index.ts", "declarations": [ { "kind": "function", "name": "IconMicOn", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMicOn", "declaration": { "name": "IconMicOn", "module": "src/generated/react/icons/icon-mic-on/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-minimize/index.ts", "declarations": [ { "kind": "function", "name": "IconMinimize", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMinimize", "declaration": { "name": "IconMinimize", "module": "src/generated/react/icons/icon-minimize/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-minus-large/index.ts", "declarations": [ { "kind": "function", "name": "IconMinusLarge", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMinusLarge", "declaration": { "name": "IconMinusLarge", "module": "src/generated/react/icons/icon-minus-large/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-minus-small/index.ts", "declarations": [ { "kind": "function", "name": "IconMinusSmall", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMinusSmall", "declaration": { "name": "IconMinusSmall", "module": "src/generated/react/icons/icon-minus-small/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-money-hand/index.ts", "declarations": [ { "kind": "function", "name": "IconMoneyHand", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMoneyHand", "declaration": { "name": "IconMoneyHand", "module": "src/generated/react/icons/icon-money-hand/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-moneybag/index.ts", "declarations": [ { "kind": "function", "name": "IconMoneybag", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMoneybag", "declaration": { "name": "IconMoneybag", "module": "src/generated/react/icons/icon-moneybag/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-moon/index.ts", "declarations": [ { "kind": "function", "name": "IconMoon", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMoon", "declaration": { "name": "IconMoon", "module": "src/generated/react/icons/icon-moon/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-mute/index.ts", "declarations": [ { "kind": "function", "name": "IconMute", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconMute", "declaration": { "name": "IconMute", "module": "src/generated/react/icons/icon-mute/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-office/index.ts", "declarations": [ { "kind": "function", "name": "IconOffice", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconOffice", "declaration": { "name": "IconOffice", "module": "src/generated/react/icons/icon-office/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-page-add/index.ts", "declarations": [ { "kind": "function", "name": "IconPageAdd", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPageAdd", "declaration": { "name": "IconPageAdd", "module": "src/generated/react/icons/icon-page-add/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-paper-plane-top-right/index.ts", "declarations": [ { "kind": "function", "name": "IconPaperPlaneTopRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPaperPlaneTopRight", "declaration": { "name": "IconPaperPlaneTopRight", "module": "src/generated/react/icons/icon-paper-plane-top-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-paperclip/index.ts", "declarations": [ { "kind": "function", "name": "IconPaperclip", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPaperclip", "declaration": { "name": "IconPaperclip", "module": "src/generated/react/icons/icon-paperclip/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-pause/index.ts", "declarations": [ { "kind": "function", "name": "IconPause", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPause", "declaration": { "name": "IconPause", "module": "src/generated/react/icons/icon-pause/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-pdf/index.ts", "declarations": [ { "kind": "function", "name": "IconPdf", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPdf", "declaration": { "name": "IconPdf", "module": "src/generated/react/icons/icon-pdf/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-pencil-sign/index.ts", "declarations": [ { "kind": "function", "name": "IconPencilSign", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPencilSign", "declaration": { "name": "IconPencilSign", "module": "src/generated/react/icons/icon-pencil-sign/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-pencil-sparkle/index.ts", "declarations": [ { "kind": "function", "name": "IconPencilSparkle", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPencilSparkle", "declaration": { "name": "IconPencilSparkle", "module": "src/generated/react/icons/icon-pencil-sparkle/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-pencil-wave/index.ts", "declarations": [ { "kind": "function", "name": "IconPencilWave", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPencilWave", "declaration": { "name": "IconPencilWave", "module": "src/generated/react/icons/icon-pencil-wave/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-pension/index.ts", "declarations": [ { "kind": "function", "name": "IconPension", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPension", "declaration": { "name": "IconPension", "module": "src/generated/react/icons/icon-pension/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-people/index.ts", "declarations": [ { "kind": "function", "name": "IconPeople", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeople", "declaration": { "name": "IconPeople", "module": "src/generated/react/icons/icon-people/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-people-a11y/index.ts", "declarations": [ { "kind": "function", "name": "IconPeopleA11y", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleA11y", "declaration": { "name": "IconPeopleA11y", "module": "src/generated/react/icons/icon-people-a11y/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-people-add/index.ts", "declarations": [ { "kind": "function", "name": "IconPeopleAdd", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleAdd", "declaration": { "name": "IconPeopleAdd", "module": "src/generated/react/icons/icon-people-add/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-people-added/index.ts", "declarations": [ { "kind": "function", "name": "IconPeopleAdded", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleAdded", "declaration": { "name": "IconPeopleAdded", "module": "src/generated/react/icons/icon-people-added/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-people-circle/index.ts", "declarations": [ { "kind": "function", "name": "IconPeopleCircle", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleCircle", "declaration": { "name": "IconPeopleCircle", "module": "src/generated/react/icons/icon-people-circle/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-people-copy/index.ts", "declarations": [ { "kind": "function", "name": "IconPeopleCopy", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleCopy", "declaration": { "name": "IconPeopleCopy", "module": "src/generated/react/icons/icon-people-copy/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-people-profile/index.ts", "declarations": [ { "kind": "function", "name": "IconPeopleProfile", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleProfile", "declaration": { "name": "IconPeopleProfile", "module": "src/generated/react/icons/icon-people-profile/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-people-remove/index.ts", "declarations": [ { "kind": "function", "name": "IconPeopleRemove", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPeopleRemove", "declaration": { "name": "IconPeopleRemove", "module": "src/generated/react/icons/icon-people-remove/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-percent/index.ts", "declarations": [ { "kind": "function", "name": "IconPercent", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPercent", "declaration": { "name": "IconPercent", "module": "src/generated/react/icons/icon-percent/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-phone/index.ts", "declarations": [ { "kind": "function", "name": "IconPhone", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPhone", "declaration": { "name": "IconPhone", "module": "src/generated/react/icons/icon-phone/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-pie-chart/index.ts", "declarations": [ { "kind": "function", "name": "IconPieChart", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPieChart", "declaration": { "name": "IconPieChart", "module": "src/generated/react/icons/icon-pie-chart/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-piggy-bank/index.ts", "declarations": [ { "kind": "function", "name": "IconPiggyBank", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPiggyBank", "declaration": { "name": "IconPiggyBank", "module": "src/generated/react/icons/icon-piggy-bank/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-pin/index.ts", "declarations": [ { "kind": "function", "name": "IconPin", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPin", "declaration": { "name": "IconPin", "module": "src/generated/react/icons/icon-pin/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-pinch/index.ts", "declarations": [ { "kind": "function", "name": "IconPinch", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPinch", "declaration": { "name": "IconPinch", "module": "src/generated/react/icons/icon-pinch/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-play/index.ts", "declarations": [ { "kind": "function", "name": "IconPlay", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPlay", "declaration": { "name": "IconPlay", "module": "src/generated/react/icons/icon-play/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-play-circle/index.ts", "declarations": [ { "kind": "function", "name": "IconPlayCircle", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPlayCircle", "declaration": { "name": "IconPlayCircle", "module": "src/generated/react/icons/icon-play-circle/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-plus-large/index.ts", "declarations": [ { "kind": "function", "name": "IconPlusLarge", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPlusLarge", "declaration": { "name": "IconPlusLarge", "module": "src/generated/react/icons/icon-plus-large/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-plus-small/index.ts", "declarations": [ { "kind": "function", "name": "IconPlusSmall", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPlusSmall", "declaration": { "name": "IconPlusSmall", "module": "src/generated/react/icons/icon-plus-small/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-png/index.ts", "declarations": [ { "kind": "function", "name": "IconPng", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPng", "declaration": { "name": "IconPng", "module": "src/generated/react/icons/icon-png/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-poop/index.ts", "declarations": [ { "kind": "function", "name": "IconPoop", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPoop", "declaration": { "name": "IconPoop", "module": "src/generated/react/icons/icon-poop/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-postcard/index.ts", "declarations": [ { "kind": "function", "name": "IconPostcard", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPostcard", "declaration": { "name": "IconPostcard", "module": "src/generated/react/icons/icon-postcard/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-pound/index.ts", "declarations": [ { "kind": "function", "name": "IconPound", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPound", "declaration": { "name": "IconPound", "module": "src/generated/react/icons/icon-pound/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-power/index.ts", "declarations": [ { "kind": "function", "name": "IconPower", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPower", "declaration": { "name": "IconPower", "module": "src/generated/react/icons/icon-power/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-power-plant/index.ts", "declarations": [ { "kind": "function", "name": "IconPowerPlant", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPowerPlant", "declaration": { "name": "IconPowerPlant", "module": "src/generated/react/icons/icon-power-plant/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-printer/index.ts", "declarations": [ { "kind": "function", "name": "IconPrinter", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPrinter", "declaration": { "name": "IconPrinter", "module": "src/generated/react/icons/icon-printer/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-push/index.ts", "declarations": [ { "kind": "function", "name": "IconPush", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconPush", "declaration": { "name": "IconPush", "module": "src/generated/react/icons/icon-push/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-qr-code/index.ts", "declarations": [ { "kind": "function", "name": "IconQrCode", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconQrCode", "declaration": { "name": "IconQrCode", "module": "src/generated/react/icons/icon-qr-code/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-rainy/index.ts", "declarations": [ { "kind": "function", "name": "IconRainy", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconRainy", "declaration": { "name": "IconRainy", "module": "src/generated/react/icons/icon-rainy/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-raising-hand/index.ts", "declarations": [ { "kind": "function", "name": "IconRaisingHand", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconRaisingHand", "declaration": { "name": "IconRaisingHand", "module": "src/generated/react/icons/icon-raising-hand/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-reading-list/index.ts", "declarations": [ { "kind": "function", "name": "IconReadingList", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconReadingList", "declaration": { "name": "IconReadingList", "module": "src/generated/react/icons/icon-reading-list/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-receipt-bill/index.ts", "declarations": [ { "kind": "function", "name": "IconReceiptBill", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconReceiptBill", "declaration": { "name": "IconReceiptBill", "module": "src/generated/react/icons/icon-receipt-bill/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-receiption-bell/index.ts", "declarations": [ { "kind": "function", "name": "IconReceiptionBell", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconReceiptionBell", "declaration": { "name": "IconReceiptionBell", "module": "src/generated/react/icons/icon-receiption-bell/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-record/index.ts", "declarations": [ { "kind": "function", "name": "IconRecord", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconRecord", "declaration": { "name": "IconRecord", "module": "src/generated/react/icons/icon-record/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-refund/index.ts", "declarations": [ { "kind": "function", "name": "IconRefund", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconRefund", "declaration": { "name": "IconRefund", "module": "src/generated/react/icons/icon-refund/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-robot/index.ts", "declarations": [ { "kind": "function", "name": "IconRobot", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconRobot", "declaration": { "name": "IconRobot", "module": "src/generated/react/icons/icon-robot/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-rocket/index.ts", "declarations": [ { "kind": "function", "name": "IconRocket", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconRocket", "declaration": { "name": "IconRocket", "module": "src/generated/react/icons/icon-rocket/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-run-shortcut/index.ts", "declarations": [ { "kind": "function", "name": "IconRunShortcut", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconRunShortcut", "declaration": { "name": "IconRunShortcut", "module": "src/generated/react/icons/icon-run-shortcut/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-safari/index.ts", "declarations": [ { "kind": "function", "name": "IconSafari", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSafari", "declaration": { "name": "IconSafari", "module": "src/generated/react/icons/icon-safari/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-school/index.ts", "declarations": [ { "kind": "function", "name": "IconSchool", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSchool", "declaration": { "name": "IconSchool", "module": "src/generated/react/icons/icon-school/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-search-menu/index.ts", "declarations": [ { "kind": "function", "name": "IconSearchMenu", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSearchMenu", "declaration": { "name": "IconSearchMenu", "module": "src/generated/react/icons/icon-search-menu/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-scissors/index.ts", "declarations": [ { "kind": "function", "name": "IconScissors", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconScissors", "declaration": { "name": "IconScissors", "module": "src/generated/react/icons/icon-scissors/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-settings-gear/index.ts", "declarations": [ { "kind": "function", "name": "IconSettingsGear", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSettingsGear", "declaration": { "name": "IconSettingsGear", "module": "src/generated/react/icons/icon-settings-gear/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-settings-slider-hor/index.ts", "declarations": [ { "kind": "function", "name": "IconSettingsSliderHor", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSettingsSliderHor", "declaration": { "name": "IconSettingsSliderHor", "module": "src/generated/react/icons/icon-settings-slider-hor/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-settings-slider-ver/index.ts", "declarations": [ { "kind": "function", "name": "IconSettingsSliderVer", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSettingsSliderVer", "declaration": { "name": "IconSettingsSliderVer", "module": "src/generated/react/icons/icon-settings-slider-ver/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-shapes/index.ts", "declarations": [ { "kind": "function", "name": "IconShapes", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconShapes", "declaration": { "name": "IconShapes", "module": "src/generated/react/icons/icon-shapes/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-share/index.ts", "declarations": [ { "kind": "function", "name": "IconShare", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconShare", "declaration": { "name": "IconShare", "module": "src/generated/react/icons/icon-share/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-shield/index.ts", "declarations": [ { "kind": "function", "name": "IconShield", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconShield", "declaration": { "name": "IconShield", "module": "src/generated/react/icons/icon-shield/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-shield-checked/index.ts", "declarations": [ { "kind": "function", "name": "IconShieldChecked", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconShieldChecked", "declaration": { "name": "IconShieldChecked", "module": "src/generated/react/icons/icon-shield-checked/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-shield-crossed/index.ts", "declarations": [ { "kind": "function", "name": "IconShieldCrossed", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconShieldCrossed", "declaration": { "name": "IconShieldCrossed", "module": "src/generated/react/icons/icon-shield-crossed/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-shopping-bag/index.ts", "declarations": [ { "kind": "function", "name": "IconShoppingBag", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconShoppingBag", "declaration": { "name": "IconShoppingBag", "module": "src/generated/react/icons/icon-shopping-bag/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-signature/index.ts", "declarations": [ { "kind": "function", "name": "IconSignature", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSignature", "declaration": { "name": "IconSignature", "module": "src/generated/react/icons/icon-signature/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-smartwatch/index.ts", "declarations": [ { "kind": "function", "name": "IconSmartwatch", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSmartwatch", "declaration": { "name": "IconSmartwatch", "module": "src/generated/react/icons/icon-smartwatch/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-solar/index.ts", "declarations": [ { "kind": "function", "name": "IconSolar", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSolar", "declaration": { "name": "IconSolar", "module": "src/generated/react/icons/icon-solar/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-sort/index.ts", "declarations": [ { "kind": "function", "name": "IconSort", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSort", "declaration": { "name": "IconSort", "module": "src/generated/react/icons/icon-sort/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-sort-ascending/index.ts", "declarations": [ { "kind": "function", "name": "IconSortAscending", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSortAscending", "declaration": { "name": "IconSortAscending", "module": "src/generated/react/icons/icon-sort-ascending/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-sort-descending/index.ts", "declarations": [ { "kind": "function", "name": "IconSortDescending", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSortDescending", "declaration": { "name": "IconSortDescending", "module": "src/generated/react/icons/icon-sort-descending/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-sort-down/index.ts", "declarations": [ { "kind": "function", "name": "IconSortDown", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSortDown", "declaration": { "name": "IconSortDown", "module": "src/generated/react/icons/icon-sort-down/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-sort-up/index.ts", "declarations": [ { "kind": "function", "name": "IconSortUp", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSortUp", "declaration": { "name": "IconSortUp", "module": "src/generated/react/icons/icon-sort-up/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-square-arrow-top-right/index.ts", "declarations": [ { "kind": "function", "name": "IconSquareArrowTopRight", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSquareArrowTopRight", "declaration": { "name": "IconSquareArrowTopRight", "module": "src/generated/react/icons/icon-square-arrow-top-right/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-square-behind-square/index.ts", "declarations": [ { "kind": "function", "name": "IconSquareBehindSquare", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSquareBehindSquare", "declaration": { "name": "IconSquareBehindSquare", "module": "src/generated/react/icons/icon-square-behind-square/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-square-grid-circle/index.ts", "declarations": [ { "kind": "function", "name": "IconSquareGridCircle", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSquareGridCircle", "declaration": { "name": "IconSquareGridCircle", "module": "src/generated/react/icons/icon-square-grid-circle/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-square-placeholder/index.ts", "declarations": [ { "kind": "function", "name": "IconSquarePlaceholder", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSquarePlaceholder", "declaration": { "name": "IconSquarePlaceholder", "module": "src/generated/react/icons/icon-square-placeholder/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-star/index.ts", "declarations": [ { "kind": "function", "name": "IconStar", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconStar", "declaration": { "name": "IconStar", "module": "src/generated/react/icons/icon-star/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-store/index.ts", "declarations": [ { "kind": "function", "name": "IconStore", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconStore", "declaration": { "name": "IconStore", "module": "src/generated/react/icons/icon-store/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-sun/index.ts", "declarations": [ { "kind": "function", "name": "IconSun", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSun", "declaration": { "name": "IconSun", "module": "src/generated/react/icons/icon-sun/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-sunset-arrow-down/index.ts", "declarations": [ { "kind": "function", "name": "IconSunsetArrowDown", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconSunsetArrowDown", "declaration": { "name": "IconSunsetArrowDown", "module": "src/generated/react/icons/icon-sunset-arrow-down/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-tag/index.ts", "declarations": [ { "kind": "function", "name": "IconTag", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTag", "declaration": { "name": "IconTag", "module": "src/generated/react/icons/icon-tag/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-target-arrow/index.ts", "declarations": [ { "kind": "function", "name": "IconTargetArrow", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTargetArrow", "declaration": { "name": "IconTargetArrow", "module": "src/generated/react/icons/icon-target-arrow/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-television/index.ts", "declarations": [ { "kind": "function", "name": "IconTelevision", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTelevision", "declaration": { "name": "IconTelevision", "module": "src/generated/react/icons/icon-television/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-tennis/index.ts", "declarations": [ { "kind": "function", "name": "IconTennis", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTennis", "declaration": { "name": "IconTennis", "module": "src/generated/react/icons/icon-tennis/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-text-edit/index.ts", "declarations": [ { "kind": "function", "name": "IconTextEdit", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTextEdit", "declaration": { "name": "IconTextEdit", "module": "src/generated/react/icons/icon-text-edit/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-thermostat/index.ts", "declarations": [ { "kind": "function", "name": "IconThermostat", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconThermostat", "declaration": { "name": "IconThermostat", "module": "src/generated/react/icons/icon-thermostat/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-thumbs-down/index.ts", "declarations": [ { "kind": "function", "name": "IconThumbsDown", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconThumbsDown", "declaration": { "name": "IconThumbsDown", "module": "src/generated/react/icons/icon-thumbs-down/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-thumbs-up/index.ts", "declarations": [ { "kind": "function", "name": "IconThumbsUp", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconThumbsUp", "declaration": { "name": "IconThumbsUp", "module": "src/generated/react/icons/icon-thumbs-up/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-ticket/index.ts", "declarations": [ { "kind": "function", "name": "IconTicket", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTicket", "declaration": { "name": "IconTicket", "module": "src/generated/react/icons/icon-ticket/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-trading-view-candles/index.ts", "declarations": [ { "kind": "function", "name": "IconTradingViewCandles", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTradingViewCandles", "declaration": { "name": "IconTradingViewCandles", "module": "src/generated/react/icons/icon-trading-view-candles/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-trash-can/index.ts", "declarations": [ { "kind": "function", "name": "IconTrashCan", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrashCan", "declaration": { "name": "IconTrashCan", "module": "src/generated/react/icons/icon-trash-can/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-tree/index.ts", "declarations": [ { "kind": "function", "name": "IconTree", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTree", "declaration": { "name": "IconTree", "module": "src/generated/react/icons/icon-tree/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-trending-five/index.ts", "declarations": [ { "kind": "function", "name": "IconTrendingFive", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrendingFive", "declaration": { "name": "IconTrendingFive", "module": "src/generated/react/icons/icon-trending-five/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-trending-four/index.ts", "declarations": [ { "kind": "function", "name": "IconTrendingFour", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrendingFour", "declaration": { "name": "IconTrendingFour", "module": "src/generated/react/icons/icon-trending-four/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-trending-one/index.ts", "declarations": [ { "kind": "function", "name": "IconTrendingOne", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrendingOne", "declaration": { "name": "IconTrendingOne", "module": "src/generated/react/icons/icon-trending-one/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-trending-three/index.ts", "declarations": [ { "kind": "function", "name": "IconTrendingThree", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrendingThree", "declaration": { "name": "IconTrendingThree", "module": "src/generated/react/icons/icon-trending-three/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-trending-two/index.ts", "declarations": [ { "kind": "function", "name": "IconTrendingTwo", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTrendingTwo", "declaration": { "name": "IconTrendingTwo", "module": "src/generated/react/icons/icon-trending-two/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-triangle-exclamation/index.ts", "declarations": [ { "kind": "function", "name": "IconTriangleExclamation", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTriangleExclamation", "declaration": { "name": "IconTriangleExclamation", "module": "src/generated/react/icons/icon-triangle-exclamation/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-truck/index.ts", "declarations": [ { "kind": "function", "name": "IconTruck", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconTruck", "declaration": { "name": "IconTruck", "module": "src/generated/react/icons/icon-truck/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-umbrella-security/index.ts", "declarations": [ { "kind": "function", "name": "IconUmbrellaSecurity", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconUmbrellaSecurity", "declaration": { "name": "IconUmbrellaSecurity", "module": "src/generated/react/icons/icon-umbrella-security/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-unlocked/index.ts", "declarations": [ { "kind": "function", "name": "IconUnlocked", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconUnlocked", "declaration": { "name": "IconUnlocked", "module": "src/generated/react/icons/icon-unlocked/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-volume-full/index.ts", "declarations": [ { "kind": "function", "name": "IconVolumeFull", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconVolumeFull", "declaration": { "name": "IconVolumeFull", "module": "src/generated/react/icons/icon-volume-full/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-volume-half/index.ts", "declarations": [ { "kind": "function", "name": "IconVolumeHalf", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconVolumeHalf", "declaration": { "name": "IconVolumeHalf", "module": "src/generated/react/icons/icon-volume-half/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-volume-off/index.ts", "declarations": [ { "kind": "function", "name": "IconVolumeOff", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconVolumeOff", "declaration": { "name": "IconVolumeOff", "module": "src/generated/react/icons/icon-volume-off/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-wallet/index.ts", "declarations": [ { "kind": "function", "name": "IconWallet", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconWallet", "declaration": { "name": "IconWallet", "module": "src/generated/react/icons/icon-wallet/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-warning-sign/index.ts", "declarations": [ { "kind": "function", "name": "IconWarningSign", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconWarningSign", "declaration": { "name": "IconWarningSign", "module": "src/generated/react/icons/icon-warning-sign/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-wifi-full/index.ts", "declarations": [ { "kind": "function", "name": "IconWifiFull", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconWifiFull", "declaration": { "name": "IconWifiFull", "module": "src/generated/react/icons/icon-wifi-full/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-youtube/index.ts", "declarations": [ { "kind": "function", "name": "IconYoutube", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconYoutube", "declaration": { "name": "IconYoutube", "module": "src/generated/react/icons/icon-youtube/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-zap/index.ts", "declarations": [ { "kind": "function", "name": "IconZap", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconZap", "declaration": { "name": "IconZap", "module": "src/generated/react/icons/icon-zap/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-zoom-in/index.ts", "declarations": [ { "kind": "function", "name": "IconZoomIn", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconZoomIn", "declaration": { "name": "IconZoomIn", "module": "src/generated/react/icons/icon-zoom-in/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/generated/react/icons/icon-zoom-out/index.ts", "declarations": [ { "kind": "function", "name": "IconZoomOut", "parameters": [ { "name": "props", "type": { "text": "React.ComponentProps<\n ReturnType>\n > & { ref?: React.Ref }" } } ] } ], "exports": [ { "kind": "js", "name": "IconZoomOut", "declaration": { "name": "IconZoomOut", "module": "src/generated/react/icons/icon-zoom-out/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/0/example.ts", "declarations": [ { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'theme-to-mode', enabled: false, // Example only — not a real migration summary: '[Example] Replace deprecated gds-theme / gdsTheme with gds-mode / gdsMode', exampleBefore: [ '', '
    Click
    ', '', '', '', '', '', '', '', '', '', '', '', '// JS property assignment', 'el.gdsTheme = \"dark\"', '', '// JS setAttribute', \"el.setAttribute('gds-theme', 'dark')\", ].join('\\n'), exampleAfter: [ '', '
    Click
    ', '', '', '', '', '', '', '', '', '', '', '', '// JS property assignment', 'el.gdsMode = \"dark\"', '', '// JS setAttribute', \"el.setAttribute('gds-mode', 'dark')\", ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx'], safe: true, detect(filePath: string, content: string): MigrationMatch[] { return detectVariants(filePath, content, VARIANTS) }, apply(_filePath: string, content: string): string | null { return applyVariants(content, VARIANTS) }, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/0/example.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/2/badge-disabled-to-variant.ts", "declarations": [ { "kind": "function", "name": "detect", "return": { "type": { "text": "MigrationMatch[]" } }, "parameters": [ { "name": "filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "function", "name": "apply", "return": { "type": { "text": "string | null" } }, "parameters": [ { "name": "_filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'badge-disabled-to-variant', enabled: true, summary: 'Replace deprecated gds-badge disabled state with variant=\"disabled\"', exampleBefore: [ 'Info', 'Warn', '', \"badge.disabled = true\", ].join('\\n'), exampleAfter: [ 'Info', 'Warn', '', \"badge.variant = 'disabled' // manual review for JS usage\", ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: false, detect, apply, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/2/badge-disabled-to-variant.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/2/button-default-brand-review.ts", "declarations": [ { "kind": "function", "name": "detect", "return": { "type": { "text": "MigrationMatch[]" } }, "parameters": [ { "name": "filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'button-default-brand-review', enabled: true, summary: 'Flag buttons without explicit variant because the 2.0 default changed from brand to neutral', exampleBefore: [ 'Submit', 'Cancel', ].join('\\n'), exampleAfter: [ 'Submit ', 'Cancel ', ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: false, detect, apply() { return null }, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/2/button-default-brand-review.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/2/card-shadow-to-box-shadow.ts", "declarations": [ { "kind": "function", "name": "detect", "return": { "type": { "text": "MigrationMatch[]" } }, "parameters": [ { "name": "filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "function", "name": "apply", "return": { "type": { "text": "string | null" } }, "parameters": [ { "name": "_filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'card-shadow-to-box-shadow', enabled: true, summary: 'Rename deprecated gds-card shadow prop to box-shadow / boxShadow', exampleBefore: [ '', '', '', \"card.shadow = 'm'\", \"card.setAttribute('shadow', 'm')\", ].join('\\n'), exampleAfter: [ '', '', '', \"card.boxShadow = 'm'\", \"card.setAttribute('box-shadow', 'm')\", ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: true, detect, apply, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/2/card-shadow-to-box-shadow.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/2/color-token-renames.ts", "declarations": [ { "kind": "function", "name": "detect", "return": { "type": { "text": "MigrationMatch[]" } }, "parameters": [ { "name": "filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "function", "name": "apply", "return": { "type": { "text": "string | null" } }, "parameters": [ { "name": "_filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'color-token-renames', enabled: true, summary: 'Rename 2.0 shorthand color tokens for color, background, border, and related properties', exampleBefore: [ '', '', '', '', ].join('\\n'), exampleAfter: [ '', '', '', '', ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: true, detect, apply, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/2/color-token-renames.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/2/divider-levels-to-color.ts", "declarations": [ { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'divider-levels-to-color', enabled: true, summary: 'Flag deprecated divider levels usage for manual migration to color', exampleBefore: [ '', '', \"divider.setAttribute('levels', '1')\", ].join('\\n'), exampleAfter: [ ' ', ' ', \"divider.setAttribute('color', '...') // manual review\", ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: false, detect, apply() { return null }, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/2/divider-levels-to-color.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/2/icon-width-height-to-size.ts", "declarations": [ { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'icon-width-height-to-size', enabled: true, summary: 'Replace deprecated icon width/height usage with size when both dimensions use the same literal value', exampleBefore: [ '', '', '', ].join('\\n'), exampleAfter: [ '', '', ' ', ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: false, detect, apply, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/2/icon-width-height-to-size.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/2/replace-container-with-div.ts", "declarations": [ { "kind": "function", "name": "detect", "return": { "type": { "text": "MigrationMatch[]" } }, "parameters": [ { "name": "filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "function", "name": "apply", "return": { "type": { "text": "string | null" } }, "parameters": [ { "name": "_filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'replace-container-with-div', enabled: true, summary: 'Replace deprecated gds-container / GdsContainer with gds-div / GdsDiv', exampleBefore: [ '', '', '', \"document.createElement('gds-container')\", ].join('\\n'), exampleAfter: [ '', '', '', \"document.createElement('gds-div')\", ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: true, detect, apply, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/2/replace-container-with-div.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/2/replace-spacer-with-div-height.ts", "declarations": [ { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'replace-spacer-with-div-height', enabled: true, summary: 'Replace deprecated gds-spacer / GdsSpacer with gds-div / GdsDiv and rename size to height', exampleBefore: [ '', '', '', '', ].join('\\n'), exampleAfter: [ '', '', '', '', ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: false, detect, apply, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/2/replace-spacer-with-div-height.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/2/text-font-size-to-font.ts", "declarations": [ { "kind": "function", "name": "detect", "return": { "type": { "text": "MigrationMatch[]" } }, "parameters": [ { "name": "filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "function", "name": "apply", "return": { "type": { "text": "string | null" } }, "parameters": [ { "name": "_filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'text-font-size-to-font', enabled: true, summary: 'Rename gds-text font-size to font and convert body/detail tokens to 2.x order ([name]-[weight]-[size])', exampleBefore: [ 'Body', 'Display', '', \"text.setAttribute('font-size', 'body-s')\", ].join('\\n'), exampleAfter: [ 'Body', 'Display', '', \"text.setAttribute('font', 'body-regular-s')\", ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: false, detect, apply, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/2/text-font-size-to-font.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/2/theme-design-version-review.ts", "declarations": [ { "kind": "function", "name": "detect", "return": { "type": { "text": "MigrationMatch[]" } }, "parameters": [ { "name": "filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'theme-design-version-review', enabled: true, summary: 'Flag gds-theme usage without explicit design version because 2.0 defaults to 2023', exampleBefore: 'Legacy style', exampleAfter: 'Legacy style ', fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: false, detect, apply() { return null }, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/2/theme-design-version-review.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/3/card-variant-renames.ts", "declarations": [ { "kind": "function", "name": "detect", "return": { "type": { "text": "MigrationMatch[]" } }, "parameters": [ { "name": "filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "function", "name": "apply", "return": { "type": { "text": "string | null" } }, "parameters": [ { "name": "_filePath", "type": { "text": "string" } }, { "name": "content", "type": { "text": "string" } } ] }, { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'card-variant-renames', enabled: true, summary: 'Replace legacy card variants (primary/secondary/tertiary) with neutral variants', exampleBefore: [ '', '', '', '', '', '', ].join('\\n'), exampleAfter: [ '', '', '', '', '', '', ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx', '.md', '.mdx'], safe: true, detect, apply, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/3/card-variant-renames.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/3/color-token-renames.ts", "declarations": [ { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'color-token-renames', enabled: true, summary: 'Rename 3.0 color tokens and flag deleted/legacy tokens for manual review', exampleBefore: [ '.button {', ' border-color: var(--gds-sys-color-border-subtle-01);', ' color: var(--gds-sys-color-content-inversed);', ' background: var(--gds-sys-color-l3-neutral-01);', '}', '.badge {', ' background: var(--gds-sys-color-l3-disabled-03);', '}', ].join('\\n'), exampleAfter: [ '.button {', ' border-color: var(--gds-sys-color-border-neutral-02);', ' color: var(--gds-sys-color-content-neutral-05);', ' background: var(--gds-sys-color-l3-neutral-03);', '}', '.badge {', ' background: var(--gds-sys-color-l3-disabled-03); /* review manually */', '}', ].join('\\n'), fileExtensions: ['.css', '.scss', '.less', '.html', '.ts', '.tsx', '.js'], safe: false, detect, apply, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/3/color-token-renames.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/3/rename-group-direction-to-flex-direction.ts", "declarations": [ { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'rename-group-direction-to-flex-direction', enabled: true, summary: 'Rename direction to flex-direction / flexDirection on gds-radio-group and gds-checkbox-group', exampleBefore: [ '', '', '', '', '', '', '', '', '', '', '', '', '', '', '// JS property assignment', \"radioGroup.direction = 'row'\", '', '// JS setAttribute', \"checkboxGroup.setAttribute('direction', 'row')\", ].join('\\n'), exampleAfter: [ '', '', '', '', '', '', '', '', '', '', '', '', '', '', '// JS property assignment', \"radioGroup.flexDirection = 'row'\", '', '// JS setAttribute', \"checkboxGroup.setAttribute('flex-direction', 'row')\", ].join('\\n'), fileExtensions: ['.html', '.ts', '.tsx', '.js', '.jsx'], safe: false, detect(filePath: string, content: string): MigrationMatch[] { return detectMatches(filePath, content) }, apply(_filePath: string, content: string): string | null { return applyRules(content) }, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/3/rename-group-direction-to-flex-direction.ts" } } ] }, { "kind": "javascript-module", "path": "src/bin/context-cli/migrate/units/3/typography-token-renames.ts", "declarations": [ { "kind": "variable", "name": "unit", "type": { "text": "MigrationUnit" }, "default": "{ id: 'typography-token-renames', enabled: true, summary: 'Rename typography tokens from [name]-[weight]-[size] to [name]-[size]-[weight] convention', exampleBefore: [ '/* CSS custom property usage */', '.heading { font: var(--gds-sys-text-body-regular-m); }', '.detail { font: var(--gds-sys-text-detail-book-s); }', '.italic { font: var(--gds-sys-text-body-italic-l); }', '', '', 'Hello', 'Hero', '', '/* Deleted token (needs manual review) */', '.hero { font: var(--gds-sys-text-display-2xl); }', ].join('\\n'), exampleAfter: [ '/* CSS custom property usage */', '.heading { font: var(--gds-sys-text-body-m-regular); }', '.detail { font: var(--gds-sys-text-detail-s-book); }', '.italic { font: var(--gds-sys-text-body-l-regular-italic); }', '', '', 'Hello', 'Hero (review manually)', '', '/* Deleted token — replace manually with closest equivalent */', '.hero { font: var(--gds-sys-text-display-l); }', ].join('\\n'), fileExtensions: ['.css', '.scss', '.less', '.html', '.ts', '.tsx', '.js'], safe: false, // Some matches (deleted tokens) require manual review detect, apply, }" } ], "exports": [ { "kind": "js", "name": "unit", "declaration": { "name": "unit", "module": "src/bin/context-cli/migrate/units/3/typography-token-renames.ts" } } ] } ] }