@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
1,487 lines • 1.78 MB
JSON
{
"timestamp": "2025-05-29T19:06:26",
"compiler": {
"name": "@arcgis/lumina-compiler",
"version": "4.33.0-next.124",
"typescriptVersion": "5.8.3"
},
"schemaVersion": "1.0.0",
"modules": [
{
"kind": "javascript-module",
"path": "src/components/accordion/accordion.tsx",
"declarations": [
{
"kind": "class",
"customElement": true,
"name": "Accordion",
"tagName": "calcite-accordion",
"superclass": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"pascalCaseName": "CalciteAccordion",
"importPath": "components/calcite-accordion",
"members": [
{
"kind": "field",
"name": "appearance",
"description": "Specifies the appearance of the component.",
"type": {
"text": "\"solid\" | \"transparent\"",
"values": [
{
"value": "solid",
"type": "string"
},
{
"value": "transparent",
"type": "string"
}
]
},
"default": "\"solid\"",
"attribute": "appearance",
"reflects": true
},
{
"kind": "method",
"name": "componentOnReady",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"module": "lib/lib.es5.d.ts",
"name": "Promise",
"package": "typescript",
"start": 0,
"end": 7
}
]
}
},
"description": "Create a promise that resolves once component is fully loaded.",
"signature": "(): Promise<void>",
"async": true,
"inheritedFrom": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"docsTags": [
{
"name": "example",
"text": "const accordion = document.createElement(\"calcite-accordion\");\ndocument.body.append(accordion);\naccordion.componentOnReady().then(() => {\n console.log(\"calcite-accordion is ready to go!\");\n});"
}
]
},
{
"kind": "field",
"name": "iconPosition",
"description": "Specifies the placement of the icon in the header.",
"type": {
"text": "\"end\" | \"start\"",
"values": [
{
"value": "end",
"type": "string"
},
{
"value": "start",
"type": "string"
}
]
},
"default": "\"end\"",
"attribute": "icon-position",
"reflects": true
},
{
"kind": "field",
"name": "iconType",
"description": "Specifies the type of the icon in the header.",
"type": {
"text": "\"caret\" | \"chevron\" | \"plus-minus\"",
"values": [
{
"value": "caret",
"type": "string"
},
{
"value": "chevron",
"type": "string"
},
{
"value": "plus-minus",
"type": "string"
}
]
},
"default": "\"chevron\"",
"attribute": "icon-type",
"reflects": true
},
{
"kind": "field",
"name": "scale",
"description": "Specifies the size of the component.",
"type": {
"text": "\"l\" | \"m\" | \"s\"",
"values": [
{
"value": "l",
"type": "string"
},
{
"value": "m",
"type": "string"
},
{
"value": "s",
"type": "string"
}
]
},
"default": "\"m\"",
"attribute": "scale",
"reflects": true
},
{
"kind": "field",
"name": "selectionMode",
"description": "Specifies the selection mode of the component, where:\n\n`\"multiple\"` allows any number of selections,\n\n`\"single\"` allows only one selection, and\n\n`\"single-persist\"` allows one selection and prevents de-selection.",
"type": {
"text": "\"multiple\" | \"single\" | \"single-persist\"",
"values": [
{
"value": "multiple",
"type": "string"
},
{
"value": "single",
"type": "string"
},
{
"value": "single-persist",
"type": "string"
}
]
},
"default": "\"multiple\"",
"attribute": "selection-mode",
"reflects": true
}
],
"attributes": [
{
"name": "appearance",
"description": "Specifies the appearance of the component.",
"type": {
"text": "\"solid\" | \"transparent\"",
"values": [
{
"value": "solid",
"type": "string"
},
{
"value": "transparent",
"type": "string"
}
]
},
"default": "\"solid\"",
"fieldName": "appearance"
},
{
"name": "icon-position",
"description": "Specifies the placement of the icon in the header.",
"type": {
"text": "\"end\" | \"start\"",
"values": [
{
"value": "end",
"type": "string"
},
{
"value": "start",
"type": "string"
}
]
},
"default": "\"end\"",
"fieldName": "iconPosition"
},
{
"name": "icon-type",
"description": "Specifies the type of the icon in the header.",
"type": {
"text": "\"caret\" | \"chevron\" | \"plus-minus\"",
"values": [
{
"value": "caret",
"type": "string"
},
{
"value": "chevron",
"type": "string"
},
{
"value": "plus-minus",
"type": "string"
}
]
},
"default": "\"chevron\"",
"fieldName": "iconType"
},
{
"name": "scale",
"description": "Specifies the size of the component.",
"type": {
"text": "\"l\" | \"m\" | \"s\"",
"values": [
{
"value": "l",
"type": "string"
},
{
"value": "m",
"type": "string"
},
{
"value": "s",
"type": "string"
}
]
},
"default": "\"m\"",
"fieldName": "scale"
},
{
"name": "selection-mode",
"description": "Specifies the selection mode of the component, where:\n\n`\"multiple\"` allows any number of selections,\n\n`\"single\"` allows only one selection, and\n\n`\"single-persist\"` allows one selection and prevents de-selection.",
"type": {
"text": "\"multiple\" | \"single\" | \"single-persist\"",
"values": [
{
"value": "multiple",
"type": "string"
},
{
"value": "single",
"type": "string"
},
{
"value": "single-persist",
"type": "string"
}
]
},
"default": "\"multiple\"",
"fieldName": "selectionMode"
}
],
"slots": [
{
"name": "",
"description": "A slot for adding `calcite-accordion-item`s. `calcite-accordion` cannot be nested, however `calcite-accordion-item`s can."
}
],
"cssProperties": [
{
"name": "--calcite-accordion-border-color",
"description": "Specifies the component's border color."
},
{
"name": "--calcite-accordion-background-color",
"description": "Specifies the component's background color."
},
{
"name": "--calcite-accordion-text-color",
"description": "Specifies the component's text color."
},
{
"name": "--calcite-accordion-text-color-hover",
"description": "Specifies the component's main text color on hover."
},
{
"name": "--calcite-accordion-text-color-press",
"description": "Specifies the component's main text color when pressed."
}
]
}
],
"exports": [
{
"kind": "custom-element-definition",
"name": "calcite-accordion",
"declaration": {
"name": "Accordion",
"module": "src/components/accordion/accordion.tsx"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/components/accordion-item/accordion-item.tsx",
"declarations": [
{
"kind": "class",
"customElement": true,
"name": "AccordionItem",
"tagName": "calcite-accordion-item",
"superclass": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"pascalCaseName": "CalciteAccordionItem",
"importPath": "components/calcite-accordion-item",
"members": [
{
"kind": "method",
"name": "componentOnReady",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"module": "lib/lib.es5.d.ts",
"name": "Promise",
"package": "typescript",
"start": 0,
"end": 7
}
]
}
},
"description": "Create a promise that resolves once component is fully loaded.",
"signature": "(): Promise<void>",
"async": true,
"inheritedFrom": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"docsTags": [
{
"name": "example",
"text": "const accordionItem = document.createElement(\"calcite-accordion-item\");\ndocument.body.append(accordionItem);\naccordionItem.componentOnReady().then(() => {\n console.log(\"calcite-accordion-item is ready to go!\");\n});"
}
]
},
{
"kind": "field",
"name": "description",
"description": "Specifies a description for the component.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"attribute": "description"
},
{
"kind": "field",
"name": "expanded",
"description": "When `true`, the component is expanded.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "expanded",
"reflects": true
},
{
"kind": "field",
"name": "heading",
"description": "Specifies heading text for the component.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"attribute": "heading"
},
{
"kind": "field",
"name": "iconEnd",
"description": "Specifies an icon to display at the end of the component.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"attribute": "icon-end",
"reflects": true
},
{
"kind": "field",
"name": "iconFlipRtl",
"description": "Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`\"rtl\"`).",
"type": {
"text": "\"both\" | \"end\" | \"start\"",
"values": [
{
"value": "both",
"type": "string"
},
{
"value": "end",
"type": "string"
},
{
"value": "start",
"type": "string"
}
]
},
"attribute": "icon-flip-rtl",
"reflects": true
},
{
"kind": "field",
"name": "iconStart",
"description": "Specifies an icon to display at the start of the component.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"attribute": "icon-start",
"reflects": true
},
{
"kind": "method",
"name": "setFocus",
"description": "Sets focus on the component.",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"name": "Promise",
"package": "typescript",
"module": "lib/lib.es5.d.ts",
"start": 0,
"end": 7
}
]
}
},
"signature": "(): Promise<void>",
"async": true
}
],
"attributes": [
{
"name": "description",
"description": "Specifies a description for the component.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "description"
},
{
"name": "expanded",
"description": "When `true`, the component is expanded.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"fieldName": "expanded"
},
{
"name": "heading",
"description": "Specifies heading text for the component.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "heading"
},
{
"name": "icon-end",
"description": "Specifies an icon to display at the end of the component.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "iconEnd"
},
{
"name": "icon-flip-rtl",
"description": "Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`\"rtl\"`).",
"type": {
"text": "\"both\" | \"end\" | \"start\"",
"values": [
{
"value": "both",
"type": "string"
},
{
"value": "end",
"type": "string"
},
{
"value": "start",
"type": "string"
}
]
},
"fieldName": "iconFlipRtl"
},
{
"name": "icon-start",
"description": "Specifies an icon to display at the start of the component.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "iconStart"
}
],
"slots": [
{
"name": "",
"description": "A slot for adding custom content, including nested `calcite-accordion-item`s."
},
{
"name": "actions-end",
"description": "A slot for adding `calcite-action`s or content to the end side of the component's header."
},
{
"name": "actions-start",
"description": "A slot for adding `calcite-action`s or content to the start side of the component's header."
}
],
"cssProperties": [
{
"name": "--calcite-accordion-border-color",
"description": "Specifies the component's border color."
},
{
"name": "--calcite-accordion-background-color",
"description": "Specifies the component's background color."
},
{
"name": "--calcite-accordion-text-color",
"description": "Specifies the component's text color."
},
{
"name": "--calcite-accordion-text-color-hover",
"description": "Specifies the component's main text color on hover."
},
{
"name": "--calcite-accordion-text-color-press",
"description": "Specifies the component's main text color when pressed."
},
{
"name": "--calcite-accordion-item-background-color",
"description": "[Deprecated] Use `--calcite-accordion-background-color`. Specifies the component's background color."
},
{
"name": "--calcite-accordion-item-border-color",
"description": "[Deprecated] Use `--calcite-accordion-border-color`. Specifies the component's border color."
},
{
"name": "--calcite-accordion-item-content-space",
"description": "Specifies the component's padding."
},
{
"name": "--calcite-accordion-item-end-icon-color",
"description": "Specifies the component's `iconEnd` color. Falls back to `--calcite-accordion-item-icon-color` or current color."
},
{
"name": "--calcite-accordion-item-expand-icon-color",
"description": "Specifies the component's expand icon color."
},
{
"name": "--calcite-accordion-item-header-background-color",
"description": "Specifies the component's `heading` background color."
},
{
"name": "--calcite-accordion-item-header-background-color-hover",
"description": "Specifies the component's `heading` background color when hovered."
},
{
"name": "--calcite-accordion-item-header-background-color-press",
"description": "Specifies the component's `heading` background color when pressed."
},
{
"name": "--calcite-accordion-item-heading-text-color",
"description": "Specifies the component's `heading` text color."
},
{
"name": "--calcite-accordion-item-icon-color",
"description": "[Deprecated] Use `--calcite-icon-color`. Specifies the component's default icon color."
},
{
"name": "--calcite-accordion-item-start-icon-color",
"description": "Specifies the component's `iconStart` color. Falls back to `--calcite-accordion-item-icon-color` or current color."
},
{
"name": "--calcite-accordion-item-text-color",
"description": "[Deprecated] Use `--calcite-accordion-text-color`. Specifies the component's text color."
},
{
"name": "--calcite-accordion-item-text-color-hover",
"description": "[Deprecated] Use `--calcite-accordion-text-color-hover`. Specifies the component's text color on hover."
},
{
"name": "--calcite-accordion-item-text-color-press",
"description": "[Deprecated] Use `--calcite-accordion-text-color-press`. Specifies the component's text color on press."
}
]
}
],
"exports": [
{
"kind": "custom-element-definition",
"name": "calcite-accordion-item",
"declaration": {
"name": "AccordionItem",
"module": "src/components/accordion-item/accordion-item.tsx"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/components/action/action.tsx",
"declarations": [
{
"kind": "class",
"customElement": true,
"name": "Action",
"tagName": "calcite-action",
"superclass": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"pascalCaseName": "CalciteAction",
"importPath": "components/calcite-action",
"members": [
{
"kind": "field",
"name": "active",
"description": "When `true`, the component is highlighted.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "active",
"reflects": true
},
{
"kind": "field",
"name": "alignment",
"description": "Specifies the horizontal alignment of button elements with text content.",
"type": {
"text": "\"center\" | \"end\" | \"start\"",
"values": [
{
"value": "center",
"type": "string"
},
{
"value": "end",
"type": "string"
},
{
"value": "start",
"type": "string"
}
]
},
"attribute": "alignment",
"reflects": true
},
{
"kind": "field",
"name": "appearance",
"description": "Specifies the appearance of the component.",
"type": {
"text": "\"solid\" | \"transparent\"",
"values": [
{
"value": "solid",
"type": "string"
},
{
"value": "transparent",
"type": "string"
}
]
},
"default": "\"solid\"",
"attribute": "appearance",
"reflects": true
},
{
"kind": "field",
"name": "compact",
"description": "When `true`, the side padding of the component is reduced.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"deprecated": "No longer necessary.",
"attribute": "compact",
"reflects": true
},
{
"kind": "method",
"name": "componentOnReady",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"module": "lib/lib.es5.d.ts",
"name": "Promise",
"package": "typescript",
"start": 0,
"end": 7
}
]
}
},
"description": "Create a promise that resolves once component is fully loaded.",
"signature": "(): Promise<void>",
"async": true,
"inheritedFrom": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"docsTags": [
{
"name": "example",
"text": "const action = document.createElement(\"calcite-action\");\ndocument.body.append(action);\naction.componentOnReady().then(() => {\n console.log(\"calcite-action is ready to go!\");\n});"
}
]
},
{
"kind": "field",
"name": "disabled",
"description": "When `true`, interaction is prevented and the component is displayed with lower opacity.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "disabled",
"reflects": true
},
{
"kind": "field",
"name": "icon",
"description": "Specifies an icon to display.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"attribute": "icon",
"reflects": true
},
{
"kind": "field",
"name": "iconFlipRtl",
"description": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`).",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "icon-flip-rtl",
"reflects": true
},
{
"kind": "field",
"name": "indicator",
"description": "When `true`, displays a visual indicator.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "indicator",
"reflects": true
},
{
"kind": "field",
"name": "label",
"description": "Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"attribute": "label"
},
{
"kind": "field",
"name": "loading",
"description": "When `true`, a busy indicator is displayed.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "loading",
"reflects": true
},
{
"kind": "field",
"name": "messageOverrides",
"description": "Use this property to override individual strings used by the component.",
"type": {
"text": "{\n loading?: string;\n indicator?: string;\n indicatorLabel?: string;\n}"
}
},
{
"kind": "field",
"name": "scale",
"description": "Specifies the size of the component.",
"type": {
"text": "\"l\" | \"m\" | \"s\"",
"values": [
{
"value": "l",
"type": "string"
},
{
"value": "m",
"type": "string"
},
{
"value": "s",
"type": "string"
}
]
},
"default": "\"m\"",
"attribute": "scale",
"reflects": true
},
{
"kind": "method",
"name": "setFocus",
"description": "Sets focus on the component.",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"name": "Promise",
"package": "typescript",
"module": "lib/lib.es5.d.ts",
"start": 0,
"end": 7
}
]
}
},
"signature": "(): Promise<void>",
"async": true
},
{
"kind": "field",
"name": "text",
"description": "Specifies text that accompanies the icon.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"attribute": "text",
"docsTags": [
{
"name": "required"
}
]
},
{
"kind": "field",
"name": "textEnabled",
"description": "Indicates whether the text is displayed.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "text-enabled",
"reflects": true
}
],
"attributes": [
{
"name": "active",
"description": "When `true`, the component is highlighted.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"fieldName": "active"
},
{
"name": "alignment",
"description": "Specifies the horizontal alignment of button elements with text content.",
"type": {
"text": "\"center\" | \"end\" | \"start\"",
"values": [
{
"value": "center",
"type": "string"
},
{
"value": "end",
"type": "string"
},
{
"value": "start",
"type": "string"
}
]
},
"fieldName": "alignment"
},
{
"name": "appearance",
"description": "Specifies the appearance of the component.",
"type": {
"text": "\"solid\" | \"transparent\"",
"values": [
{
"value": "solid",
"type": "string"
},
{
"value": "transparent",
"type": "string"
}
]
},
"default": "\"solid\"",
"fieldName": "appearance"
},
{
"name": "compact",
"description": "When `true`, the side padding of the component is reduced.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"fieldName": "compact",
"deprecated": "No longer necessary."
},
{
"name": "disabled",
"description": "When `true`, interaction is prevented and the component is displayed with lower opacity.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"fieldName": "disabled"
},
{
"name": "icon",
"description": "Specifies an icon to display.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "icon"
},
{
"name": "icon-flip-rtl",
"description": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`).",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"fieldName": "iconFlipRtl"
},
{
"name": "indicator",
"description": "When `true`, displays a visual indicator.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"fieldName": "indicator"
},
{
"name": "label",
"description": "Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "label"
},
{
"name": "loading",
"description": "When `true`, a busy indicator is displayed.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"fieldName": "loading"
},
{
"name": "scale",
"description": "Specifies the size of the component.",
"type": {
"text": "\"l\" | \"m\" | \"s\"",
"values": [
{
"value": "l",
"type": "string"
},
{
"value": "m",
"type": "string"
},
{
"value": "s",
"type": "string"
}
]
},
"default": "\"m\"",
"fieldName": "scale"
},
{
"name": "text",
"description": "Specifies text that accompanies the icon.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "text"
},
{
"name": "text-enabled",
"description": "Indicates whether the text is displayed.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"fieldName": "textEnabled"
}
],
"slots": [
{
"name": "",
"description": "A slot for adding a `calcite-icon`."
},
{
"name": "tooltip",
"description": "[Deprecated] Use the `calcite-tooltip` component instead."
}
],
"cssProperties": [
{
"name": "--calcite-action-background-color-hover",
"description": "Specifies the component's background color when hovered or focused."
},
{
"name": "--calcite-action-background-color-press",
"description": "Specifies the component's background color when active."
},
{
"name": "--calcite-action-background-color-pressed",
"description": "[Deprecated] Use --calcite-action-background-color-press. Specifies the component's background color when active."
},
{
"name": "--calcite-action-background-color",
"description": "Specifies the component's background color."
},
{
"name": "--calcite-action-corner-radius-end-end",
"description": "[Deprecated] Use --calcite-action-corner-radius. Specifies the component's corner radius end end."
},
{
"name": "--calcite-action-corner-radius-end-start",
"description": "[Deprecated] Use --calcite-action-corner-radius. Specifies the component's corner radius end start."
},
{
"name": "--calcite-action-corner-radius-start-end",
"description": "[Deprecated] Use --calcite-action-corner-radius. Specifies the component's corner radius start end."
},
{
"name": "--calcite-action-corner-radius-start-start",
"description": "[Deprecated] Use --calcite-action-corner-radius. Specifies the component's corner radius start start."
},
{
"name": "--calcite-action-corner-radius",
"description": "Specifies the component's corner radius."
},
{
"name": "--calcite-action-indicator-color",
"description": "Specifies the component's indicator color."
},
{
"name": "--calcite-action-text-color-press",
"description": "Specifies the component's text color when pressed or hovered."
},
{
"name": "--calcite-action-text-color-pressed",
"description": "[Deprecated] Use --calcite-action-text-color-press. Specifies the component's text color when hovered."
},
{
"name": "--calcite-action-text-color",
"description": "Specifies the component's text color."
}
]
}
],
"exports": [
{
"kind": "custom-element-definition",
"name": "calcite-action",
"declaration": {
"name": "Action",
"module": "src/components/action/action.tsx"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/components/action-bar/action-bar.tsx",
"declarations": [
{
"kind": "class",
"customElement": true,
"name": "ActionBar",
"tagName": "calcite-action-bar",
"superclass": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"pascalCaseName": "CalciteActionBar",
"importPath": "components/calcite-action-bar",
"members": [
{
"kind": "field",
"name": "actionsEndGroupLabel",
"description": "Specifies the accessible label for the last `calcite-action-group`.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"attribute": "actions-end-group-label"
},
{
"kind": "method",
"name": "componentOnReady",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"module": "lib/lib.es5.d.ts",
"name": "Promise",
"package": "typescript",
"start": 0,
"end": 7
}
]
}
},
"description": "Create a promise that resolves once component is fully loaded.",
"signature": "(): Promise<void>",
"async": true,
"inheritedFrom": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"docsTags": [
{
"name": "example",
"text": "const actionBar = document.createElement(\"calcite-action-bar\");\ndocument.body.append(actionBar);\nactionBar.componentOnReady().then(() => {\n console.log(\"calcite-action-bar is ready to go!\");\n});"
}
]
},
{
"kind": "field",
"name": "expandDisabled",
"description": "When `true`, the expand-toggling behavior is disabled.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "expand-disabled",
"reflects": true
},
{
"kind": "field",
"name": "expanded",
"description": "When `true`, the component is expanded.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "expanded",
"reflects": true
},
{
"kind": "field",
"name": "floating",
"description": "When `true`, the component is in a floating state.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "floating",
"reflects": true
},
{
"kind": "field",
"name": "layout",
"description": "Specifies the layout direction of the actions.",
"type": {
"text": "\"grid\" | \"horizontal\" | \"vertical\"",
"values": [
{
"value": "grid",
"type": "string"
},
{
"value": "horizontal",
"type": "string"
},
{
"value": "vertical",
"type": "string"
}
]
},
"default": "\"vertical\"",
"attribute": "layout",
"reflects": true
},
{
"kind": "field",
"name": "messageOverrides",
"description": "Use this property to override individual strings used by the component.",
"type": {
"text": "{\n expand?: string;\n collapse?: string;\n expandLabel?: string;\n collapseLabel?: string;\n}"
}
},
{
"kind": "field",
"name": "overflowActionsDisabled",
"description": "Disables automatically overflowing `calcite-action`s that won't fit into menus.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "overflow-actions-disabled",
"reflects": true
},
{
"kind": "field",
"name": "overlayPositioning",
"description": "Determines the type of positioning to use for the overlaid content.\n\nUsing `\"absolute\"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout.\n\n`\"fixed\"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `\"fixed\"`.",
"type": {
"text": "\"absolute\" | \"fixed\"",
"values": [
{
"value": "absolute",
"type": "string"
},
{
"value": "fixed",
"type": "string"
}
]
},
"default": "\"absolute\"",
"attribute": "overlay-positioning",
"reflects": true
},
{
"kind": "field",
"name": "position",
"description": "Arranges the component depending on the element's `dir` property.",
"type": {
"text": "\"end\" | \"start\"",
"values": [
{
"value": "end",
"type": "string"
},
{
"value": "start",
"type": "string"
}
]
},
"attribute": "position",
"reflects": true
},
{
"kind": "field",
"name": "scale",
"description": "Specifies the size of the expand `calcite-action`.",
"type": {
"text": "\"l\" | \"m\" | \"s\"",
"values": [
{
"value": "l",
"type": "string"
},
{
"value