{ "timestamp": "2022-10-27T20:27:56", "compiler": { "name": "@stencil/core", "version": "2.18.1", "typescriptVersion": "4.7.4" }, "components": [ { "filePath": "./src/components/accordion/accordion.tsx", "encapsulation": "shadow", "tag": "calcite-accordion", "readme": "# calcite-accordion\n\n`calcite-accordion` can be used to present content in collapsible sections. Configuration options exist for visual style (icon-position, scale, appearance), and selection functionality. Selection modes include \"multi\", \"single\", and \"single-persist\".\n", "docs": "`calcite-accordion` can be used to present content in collapsible sections. Configuration options exist for visual style (icon-position, scale, appearance), and selection functionality. Selection modes include \"multi\", \"single\", and \"single-persist\".", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-accordion-item`s. `calcite-accordion` cannot be nested, however `calcite-accordion-item`s can." } ], "usage": { "Basic": "```html\n\n Accordion Section Content \n Accordion Section Content \n Accordion Section Content \n\n```\n" }, "props": [ { "name": "appearance", "type": "\"default\" | \"minimal\" | \"solid\" | \"transparent\"", "mutable": false, "attr": "appearance", "reflectToAttr": true, "docs": "Specifies the appearance of the component.", "docsTags": [], "default": "\"solid\"", "values": [ { "value": "default", "type": "string" }, { "value": "minimal", "type": "string" }, { "value": "solid", "type": "string" }, { "value": "transparent", "type": "string" } ], "optional": false, "required": false }, { "name": "iconPosition", "type": "\"end\" | \"start\"", "mutable": false, "attr": "icon-position", "reflectToAttr": true, "docs": "Specifies the placement of the icon in the header.", "docsTags": [], "default": "\"end\"", "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": false, "required": false }, { "name": "iconType", "type": "\"caret\" | \"chevron\" | \"plus-minus\"", "mutable": false, "attr": "icon-type", "reflectToAttr": true, "docs": "Specifies the type of the icon in the header.", "docsTags": [], "default": "\"chevron\"", "values": [ { "value": "caret", "type": "string" }, { "value": "chevron", "type": "string" }, { "value": "plus-minus", "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "selectionMode", "type": "\"multi\" | \"single\" | \"single-persist\"", "mutable": false, "attr": "selection-mode", "reflectToAttr": true, "docs": "Specifies the selection mode - `\"multi\"` (allow any number of open items), `\"single\"` (allow one open item),\nor `\"single-persist\"` (allow and require one open item).", "docsTags": [], "default": "\"multi\"", "values": [ { "value": "multi", "type": "string" }, { "value": "single", "type": "string" }, { "value": "single-persist", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [ { "event": "calciteInternalAccordionItemKeyEvent", "capture": false, "passive": false }, { "event": "calciteInternalAccordionItemRegister", "capture": false, "passive": false }, { "event": "calciteInternalAccordionItemSelect", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-accordion-item`s. `calcite-accordion` cannot be nested, however `calcite-accordion-item`s can." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/accordion-item/accordion-item.tsx", "encapsulation": "shadow", "tag": "calcite-accordion-item", "readme": "# calcite-accordion-item\n\nindividual `calcite-accordion` item\n", "docs": "individual `calcite-accordion` item", "docsTags": [ { "name": "slot", "text": "- A slot for adding custom content, including nested `calcite-accordion-item`s." } ], "usage": {}, "props": [ { "name": "active", "type": "boolean", "mutable": true, "attr": "active", "reflectToAttr": true, "docs": "When `true`, the component is active.", "docsTags": [ { "name": "deprecated", "text": "use `expanded` instead." } ], "default": "false", "deprecation": "use `expanded` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": false, "docs": "Specifies a description for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "expanded", "type": "boolean", "mutable": true, "attr": "expanded", "reflectToAttr": true, "docs": "When `true`, the component is expanded.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "heading", "type": "string", "mutable": false, "attr": "heading", "reflectToAttr": false, "docs": "Specifies heading text for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "icon", "type": "string", "mutable": true, "attr": "icon", "reflectToAttr": true, "docs": "Specifies an icon to display.", "docsTags": [ { "name": "deprecated", "text": "use `iconStart` or `iconEnd` instead." } ], "deprecation": "use `iconStart` or `iconEnd` instead.", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "iconEnd", "type": "string", "mutable": false, "attr": "icon-end", "reflectToAttr": true, "docs": "Specifies an icon to display at the end of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "iconStart", "type": "string", "mutable": false, "attr": "icon-start", "reflectToAttr": true, "docs": "Specifies an icon to display at the start of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "itemSubtitle", "type": "string", "mutable": false, "attr": "item-subtitle", "reflectToAttr": false, "docs": "Specifies a subtitle for the component.", "docsTags": [ { "name": "deprecated", "text": "Use `description` instead." } ], "deprecation": "Use `description` instead.", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "itemTitle", "type": "string", "mutable": false, "attr": "item-title", "reflectToAttr": false, "docs": "Specifies a title for the component.", "docsTags": [ { "name": "deprecated", "text": "Use `heading` instead." } ], "deprecation": "Use `heading` instead.", "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [ { "event": "keydown", "capture": false, "passive": false }, { "event": "calciteInternalAccordionChange", "target": "body", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding custom content, including nested `calcite-accordion-item`s." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-icon" ], "dependencyGraph": { "calcite-accordion-item": [ "calcite-icon" ] } }, { "filePath": "./src/components/action/action.tsx", "encapsulation": "shadow", "tag": "calcite-action", "readme": "# calcite-action\n\nThe `calcite-action` component lives in either a `calcite-action-bar` or `calcite-action-pad`. Actions look like an icon with a text description option of the component that will be revealed when the icon/ text is clicked or selected.\n", "docs": "The `calcite-action` component lives in either a `calcite-action-bar` or `calcite-action-pad`. Actions look like an icon with a text description option of the component that will be revealed when the icon/ text is clicked or selected.", "docsTags": [ { "name": "slot", "text": "- A slot for adding a `calcite-icon`." } ], "usage": { "Clear-appearance": "Renders a `calcite-action` that has a clear background.\n\n```html\n\n```\n", "With-text-displayed": "Renders a `calcite-action` that displays text alongside an icon.\n\n```html\n\n```\n", "With-tooltip": "Renders a `calcite-action` that displays text alongside an icon. A `calcite-tooltip` will be displayed on hover or focus.\n\n```html\nSave me!\n```\n", "Without-text-displayed": "Renders a `calcite-action` that displays only an icon.\n\n```html\n\n```\n" }, "props": [ { "name": "active", "type": "boolean", "mutable": false, "attr": "active", "reflectToAttr": true, "docs": "When `true`, the component is highlighted.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "alignment", "type": "\"center\" | \"end\" | \"start\"", "mutable": false, "attr": "alignment", "reflectToAttr": true, "docs": "Specifies the horizontal alignment of button elements with text content.", "docsTags": [], "values": [ { "value": "center", "type": "string" }, { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": true, "required": false }, { "name": "appearance", "type": "\"clear\" | \"solid\"", "mutable": false, "attr": "appearance", "reflectToAttr": true, "docs": "Specifies the appearance of the component.", "docsTags": [], "default": "\"solid\"", "values": [ { "value": "clear", "type": "string" }, { "value": "solid", "type": "string" } ], "optional": false, "required": false }, { "name": "compact", "type": "boolean", "mutable": false, "attr": "compact", "reflectToAttr": true, "docs": "When `true`, the side padding of the component is reduced. Compact mode is used internally by components, e.g. `calcite-block-section`.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "icon", "type": "string", "mutable": false, "attr": "icon", "reflectToAttr": false, "docs": "Specifies an icon to display.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "indicator", "type": "boolean", "mutable": false, "attr": "indicator", "reflectToAttr": true, "docs": "When `true`, indicates unread changes.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "intlLoading", "type": "string", "mutable": false, "attr": "intl-loading", "reflectToAttr": false, "docs": "Specifies the text label to display while loading.", "docsTags": [ { "name": "default", "text": "\"Loading\"" } ], "default": "TEXT.loading", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When `true`, a busy indicator is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "text", "type": "string", "mutable": false, "attr": "text", "reflectToAttr": false, "docs": "Specifies text that accompanies the icon.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "textEnabled", "type": "boolean", "mutable": false, "attr": "text-enabled", "reflectToAttr": true, "docs": "Indicates whether the text is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteActionClick", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the component has been clicked.", "docsTags": [ { "name": "deprecated", "text": "use `onClick` instead." } ], "deprecation": "use `onClick` instead." } ], "listeners": [], "styles": [ { "name": "--calcite-action-indicator-color", "annotation": "prop", "docs": "Specifies the color of the component's indicator." } ], "slots": [ { "name": "", "docs": "A slot for adding a `calcite-icon`." } ], "parts": [], "dependents": [ "calcite-action-bar", "calcite-action-group", "calcite-action-menu", "calcite-action-pad", "calcite-flow-item", "calcite-panel", "calcite-pick-list-item", "calcite-popover", "calcite-tip", "calcite-tip-manager" ], "dependencies": [ "calcite-loader", "calcite-icon" ], "dependencyGraph": { "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-action-bar": [ "calcite-action" ], "calcite-action-group": [ "calcite-action" ], "calcite-action-menu": [ "calcite-action" ], "calcite-action-pad": [ "calcite-action" ], "calcite-flow-item": [ "calcite-action" ], "calcite-panel": [ "calcite-action" ], "calcite-pick-list-item": [ "calcite-action" ], "calcite-popover": [ "calcite-action" ], "calcite-tip": [ "calcite-action" ], "calcite-tip-manager": [ "calcite-action" ] } }, { "filePath": "./src/components/action-bar/action-bar.tsx", "encapsulation": "shadow", "tag": "calcite-action-bar", "readme": "# calcite-action-bar\n\n## Description\n\nThe `calcite-action-bar` component is made up of multiple `calcite-action`s in the form of clickable icons. The action bar can be expanded to view actions with descriptive text or made smaller to view with just icons.\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-action`s that will appear at the top of the action bar." }, { "name": "slot", "text": "bottom-actions - A slot for adding `calcite-action`s that will appear at the bottom of the action bar, above the collapse/expand button." }, { "name": "slot", "text": "expand-tooltip - Used to set the tooltip for the expand toggle." } ], "usage": { "Basic": "Renders `calcite-action`s that stick to the top of the bar.\n\n```html\n\n \n \n\n```\n", "Bottom-actions": "The bottom-actions slot renders `calcite-action`s that stick to the bottom of the bar above the expand/collapse icon.\n\n```html\n\n \n \n\n```\n", "Tooltip": "Renders with a tooltip on the expand action.\n\n```html\n\n Expand\n \n\n```\n", "With-grouping": "Renders a group of `calcite-action`s contained in a `calcite-action-group`. Actions in a group are visually separated from other groups or actions in the bar.\n\n```html\n\n \n \n \n \n\n \n \n \n \n\n```\n" }, "props": [ { "name": "expandDisabled", "type": "boolean", "mutable": false, "attr": "expand-disabled", "reflectToAttr": true, "docs": "When `true`, the expand-toggling behavior is disabled.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "expanded", "type": "boolean", "mutable": true, "attr": "expanded", "reflectToAttr": true, "docs": "When `true`, the component is expanded.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "intlCollapse", "type": "string", "mutable": false, "attr": "intl-collapse", "reflectToAttr": false, "docs": "Specifies the label of the collapse icon when the component is expanded.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlExpand", "type": "string", "mutable": false, "attr": "intl-expand", "reflectToAttr": false, "docs": "Specifies the label of the expand icon when the component is collapsed.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layout", "type": "\"horizontal\" | \"vertical\"", "mutable": false, "attr": "layout", "reflectToAttr": true, "docs": "The layout direction of the actions.", "docsTags": [], "default": "\"vertical\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": false, "required": false }, { "name": "overflowActionsDisabled", "type": "boolean", "mutable": false, "attr": "overflow-actions-disabled", "reflectToAttr": true, "docs": "Disables automatically overflowing `calcite-action`s that won't fit into menus.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "position", "type": "\"end\" | \"start\"", "mutable": false, "attr": "position", "reflectToAttr": true, "docs": "Arranges the component depending on the element's `dir` property.", "docsTags": [], "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the expand `calcite-action`.", "docsTags": [], "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus(focusId?: \"expand-toggle\") => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [ { "name": "param", "text": "focusId" } ] } ], "events": [ { "event": "calciteActionBarToggle", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the `expanded` property is toggled.", "docsTags": [] } ], "listeners": [], "styles": [ { "name": "--calcite-action-bar-expanded-max-width", "annotation": "prop", "docs": "optionally specify the expanded max width of the action bar when in \"vertical\" layout." } ], "slots": [ { "name": "", "docs": "A slot for adding `calcite-action`s that will appear at the top of the action bar." }, { "name": "bottom-actions", "docs": "A slot for adding `calcite-action`s that will appear at the bottom of the action bar, above the collapse/expand button." }, { "name": "expand-tooltip", "docs": "Used to set the tooltip for the expand toggle." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-action-group", "calcite-action" ], "dependencyGraph": { "calcite-action-bar": [ "calcite-action-group", "calcite-action" ], "calcite-action-group": [ "calcite-action-menu", "calcite-action" ], "calcite-action-menu": [ "calcite-action", "calcite-popover" ], "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-popover": [ "calcite-action", "calcite-icon" ] } }, { "filePath": "./src/components/action-group/action-group.tsx", "encapsulation": "shadow", "tag": "calcite-action-group", "readme": "# calcite-action-group\n\nThe `calcite-action-group` is a wrapper for multiple `calcite-action`s and housed in `calcite-action-bar` and `calcite-action-pad`.\n", "docs": "The `calcite-action-group` is a wrapper for multiple `calcite-action`s and housed in `calcite-action-bar` and `calcite-action-pad`.", "docsTags": [ { "name": "slot", "text": "- A slot for adding a group of `calcite-action`s." }, { "name": "slot", "text": "menu-actions - A slot for adding an overflow menu with `calcite-action`s inside a `calcite-dropdown`." }, { "name": "slot", "text": "menu-tooltip - A slot for adding a `calcite-tooltip` for the menu." } ], "usage": {}, "props": [ { "name": "columns", "type": "1 | 2 | 3 | 4 | 5 | 6", "mutable": false, "attr": "columns", "reflectToAttr": true, "docs": "Indicates number of columns.", "docsTags": [], "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "optional": true, "required": false }, { "name": "expanded", "type": "boolean", "mutable": false, "attr": "expanded", "reflectToAttr": true, "docs": "When `true`, the component is expanded.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "intlMore", "type": "string", "mutable": false, "attr": "intl-more", "reflectToAttr": false, "docs": "Specifies a text string for the `calcite-action-menu`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layout", "type": "\"grid\" | \"horizontal\" | \"vertical\"", "mutable": false, "attr": "layout", "reflectToAttr": true, "docs": "Indicates the layout of the component.", "docsTags": [], "default": "\"vertical\"", "values": [ { "value": "grid", "type": "string" }, { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": false, "required": false }, { "name": "menuOpen", "type": "boolean", "mutable": true, "attr": "menu-open", "reflectToAttr": true, "docs": "When `true`, the `calcite-action-menu` is open.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the `calcite-action-menu`.", "docsTags": [], "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--calcite-action-group-columns", "annotation": "prop", "docs": "Sets number of grid-template-columns when the `layout` property is `\"grid\"`." } ], "slots": [ { "name": "", "docs": "A slot for adding a group of `calcite-action`s." }, { "name": "menu-actions", "docs": "A slot for adding an overflow menu with `calcite-action`s inside a `calcite-dropdown`." }, { "name": "menu-tooltip", "docs": "A slot for adding a `calcite-tooltip` for the menu." } ], "parts": [], "dependents": [ "calcite-action-bar", "calcite-action-pad" ], "dependencies": [ "calcite-action-menu", "calcite-action" ], "dependencyGraph": { "calcite-action-group": [ "calcite-action-menu", "calcite-action" ], "calcite-action-menu": [ "calcite-action", "calcite-popover" ], "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-popover": [ "calcite-action", "calcite-icon" ], "calcite-action-bar": [ "calcite-action-group" ], "calcite-action-pad": [ "calcite-action-group" ] } }, { "filePath": "./src/components/action-menu/action-menu.tsx", "encapsulation": "shadow", "tag": "calcite-action-menu", "readme": "# calcite-action-menu\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-action`s." }, { "name": "slot", "text": "trigger - A slot for adding a `calcite-action` to trigger opening the menu." }, { "name": "slot", "text": "tooltip - A slot for adding an tooltip for the menu." } ], "usage": {}, "props": [ { "name": "expanded", "type": "boolean", "mutable": false, "attr": "expanded", "reflectToAttr": true, "docs": "When `true`, the component is expanded.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "flipPlacements", "type": "Placement[]", "mutable": false, "reflectToAttr": false, "docs": "Defines the available placements that can be used when a flip occurs.", "docsTags": [], "values": [ { "type": "Placement[]" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Specifies the text string for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "open", "type": "boolean", "mutable": true, "attr": "open", "reflectToAttr": true, "docs": "When `true`, the component is open.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "overlayPositioning", "type": "\"absolute\" | \"fixed\"", "mutable": false, "attr": "overlay-positioning", "reflectToAttr": true, "docs": "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`\"fixed\"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `\"fixed\"`.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "type": "string" } ], "optional": false, "required": false }, { "name": "placement", "type": "Placement | VariationPlacement | AutoPlacement | DeprecatedPlacement", "mutable": false, "attr": "placement", "reflectToAttr": true, "docs": "Determines where the component will be positioned relative to the `referenceElement`.", "docsTags": [ { "name": "see", "text": "[LogicalPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/floating-ui.ts#L25)" } ], "default": "\"auto\"", "values": [ { "type": "Placement" }, { "type": "VariationPlacement" }, { "type": "AutoPlacement" }, { "type": "DeprecatedPlacement" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component's trigger `calcite-action`.", "docsTags": [], "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteActionMenuOpenChange", "detail": "any", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the `open` property has changed.\n\n**Note:**: The event payload is deprecated, please use the `open` property on the component instead", "docsTags": [] } ], "listeners": [ { "event": "pointerdown", "target": "window", "capture": false, "passive": true } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-action`s." }, { "name": "tooltip", "docs": "A slot for adding an tooltip for the menu." }, { "name": "trigger", "docs": "A slot for adding a `calcite-action` to trigger opening the menu." } ], "parts": [], "dependents": [ "calcite-action-group", "calcite-block", "calcite-panel" ], "dependencies": [ "calcite-action", "calcite-popover" ], "dependencyGraph": { "calcite-action-menu": [ "calcite-action", "calcite-popover" ], "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-popover": [ "calcite-action", "calcite-icon" ], "calcite-action-group": [ "calcite-action-menu" ], "calcite-block": [ "calcite-action-menu" ], "calcite-panel": [ "calcite-action-menu" ] } }, { "filePath": "./src/components/action-pad/action-pad.tsx", "encapsulation": "shadow", "tag": "calcite-action-pad", "readme": "# calcite-action-pad\n\nThe `calcite-action-pad` component is made up of `calcite-action`s in the form of clickable icons. This does not have an expandable option and is a smaller and simpler component than `calcite-action-bar`.\n", "docs": "The `calcite-action-pad` component is made up of `calcite-action`s in the form of clickable icons. This does not have an expandable option and is a smaller and simpler component than `calcite-action-bar`.", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-action`s to the component." }, { "name": "slot", "text": "expand-tooltip - Used to set the `calcite-tooltip` for the expand toggle." } ], "usage": { "Basic": "Renders a basic action pad with `calcite-action`s.\n\n```html\n\n \n \n\n```\n", "Tooltip": "Renders an action pad with a tooltip on the expand action.\n\n```html\n\n \n\nExpand\n\n```\n", "With-grouping": "Renders a group of `calcite-action`s contained in a `calcite-action-group`. Actions in a group are visually separated from other groups or actions in the pad.\n\n```html\n\n \n \n \n \n\n \n\n```\n" }, "props": [ { "name": "expandDisabled", "type": "boolean", "mutable": false, "attr": "expand-disabled", "reflectToAttr": true, "docs": "When `true`, the expand-toggling behavior is disabled.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "expanded", "type": "boolean", "mutable": true, "attr": "expanded", "reflectToAttr": true, "docs": "When `true`, the component is expanded.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "intlCollapse", "type": "string", "mutable": false, "attr": "intl-collapse", "reflectToAttr": false, "docs": "Specifies the label of the collapse icon when the component is expanded.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlExpand", "type": "string", "mutable": false, "attr": "intl-expand", "reflectToAttr": false, "docs": "Specifies the label of the expand icon when the component is collapsed.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layout", "type": "\"grid\" | \"horizontal\" | \"vertical\"", "mutable": false, "attr": "layout", "reflectToAttr": true, "docs": "Indicates the layout of the component.", "docsTags": [], "default": "\"vertical\"", "values": [ { "value": "grid", "type": "string" }, { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": false, "required": false }, { "name": "position", "type": "\"end\" | \"start\"", "mutable": false, "attr": "position", "reflectToAttr": true, "docs": "Arranges the component depending on the element's `dir` property.", "docsTags": [], "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the expand `calcite-action`.", "docsTags": [], "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus(focusId?: \"expand-toggle\") => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [ { "name": "param", "text": "focusId" } ] } ], "events": [ { "event": "calciteActionPadToggle", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the `expanded` property is toggled.", "docsTags": [] } ], "listeners": [], "styles": [ { "name": "--calcite-action-pad-expanded-max-width", "annotation": "prop", "docs": "optionally specify the expanded max width of the action pad when in \"vertical\" layout." } ], "slots": [ { "name": "", "docs": "A slot for adding `calcite-action`s to the component." }, { "name": "expand-tooltip", "docs": "Used to set the `calcite-tooltip` for the expand toggle." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-action-group", "calcite-action" ], "dependencyGraph": { "calcite-action-pad": [ "calcite-action-group", "calcite-action" ], "calcite-action-group": [ "calcite-action-menu", "calcite-action" ], "calcite-action-menu": [ "calcite-action", "calcite-popover" ], "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-popover": [ "calcite-action", "calcite-icon" ] } }, { "filePath": "./src/components/alert/alert.tsx", "encapsulation": "shadow", "tag": "calcite-alert", "readme": "# calcite-alert\n", "docs": "", "docsTags": [ { "name": "slot", "text": "title - A slot for optionally adding a title to the component." }, { "name": "slot", "text": "message - A slot for adding main text to the component." }, { "name": "slot", "text": "link - A slot for optionally adding an action to take from the alert (undo, try again, link to page, etc.)" } ], "usage": { "Basic": "A single instance of an alert. Multiple alerts will aggregate in a queue.\n\n```html\n\n
Title of alert
\n
Message text of the alert
\n Retry\n
\n```\n" }, "props": [ { "name": "active", "type": "boolean", "mutable": true, "attr": "active", "reflectToAttr": true, "docs": "When `true`, displays and positions the component.", "docsTags": [ { "name": "deprecated", "text": "use `open` instead." } ], "default": "false", "deprecation": "use `open` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "autoDismiss", "type": "boolean", "mutable": false, "attr": "auto-dismiss", "reflectToAttr": true, "docs": "When `true`, the component closes automatically (recommended for passive, non-blocking alerts).", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "autoDismissDuration", "type": "\"fast\" | \"medium\" | \"slow\"", "mutable": false, "attr": "auto-dismiss-duration", "reflectToAttr": true, "docs": "Specifies the duration before the component automatically closes (only use with `autoDismiss`).", "docsTags": [], "default": "this.autoDismiss ? \"medium\" : null", "values": [ { "value": "fast", "type": "string" }, { "value": "medium", "type": "string" }, { "value": "slow", "type": "string" } ], "optional": false, "required": false }, { "name": "color", "type": "\"blue\" | \"green\" | \"red\" | \"yellow\"", "mutable": false, "attr": "color", "reflectToAttr": true, "docs": "Specifies the color for the component (will apply to top border and icon).", "docsTags": [], "default": "\"blue\"", "values": [ { "value": "blue", "type": "string" }, { "value": "green", "type": "string" }, { "value": "red", "type": "string" }, { "value": "yellow", "type": "string" } ], "optional": false, "required": false }, { "name": "icon", "type": "boolean | string", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "When `true`, shows a default recommended icon. Alternatively,\npass a Calcite UI Icon name to display a specific icon.", "docsTags": [], "values": [ { "type": "boolean" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "intlClose", "type": "string", "mutable": false, "attr": "intl-close", "reflectToAttr": false, "docs": "Specifies the text label for the close button.", "docsTags": [ { "name": "default", "text": "\"Close\"" } ], "default": "TEXT.intlClose", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Specifies an accessible name for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "numberingSystem", "type": "\"arab\" | \"arabext\" | \"bali\" | \"beng\" | \"deva\" | \"fullwide\" | \"gujr\" | \"guru\" | \"hanidec\" | \"khmr\" | \"knda\" | \"laoo\" | \"latn\" | \"limb\" | \"mlym\" | \"mong\" | \"mymr\" | \"orya\" | \"tamldec\" | \"telu\" | \"thai\" | \"tibt\"", "mutable": false, "attr": "numbering-system", "reflectToAttr": true, "docs": "Specifies the Unicode numeral system used by the component for localization.", "docsTags": [], "values": [ { "value": "arab", "type": "string" }, { "value": "arabext", "type": "string" }, { "value": "bali", "type": "string" }, { "value": "beng", "type": "string" }, { "value": "deva", "type": "string" }, { "value": "fullwide", "type": "string" }, { "value": "gujr", "type": "string" }, { "value": "guru", "type": "string" }, { "value": "hanidec", "type": "string" }, { "value": "khmr", "type": "string" }, { "value": "knda", "type": "string" }, { "value": "laoo", "type": "string" }, { "value": "latn", "type": "string" }, { "value": "limb", "type": "string" }, { "value": "mlym", "type": "string" }, { "value": "mong", "type": "string" }, { "value": "mymr", "type": "string" }, { "value": "orya", "type": "string" }, { "value": "tamldec", "type": "string" }, { "value": "telu", "type": "string" }, { "value": "thai", "type": "string" }, { "value": "tibt", "type": "string" } ], "optional": true, "required": false }, { "name": "open", "type": "boolean", "mutable": true, "attr": "open", "reflectToAttr": true, "docs": "When `true`, displays and positions the component.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "placement", "type": "\"bottom\" | \"bottom-end\" | \"bottom-start\" | \"top\" | \"top-end\" | \"top-start\"", "mutable": false, "attr": "placement", "reflectToAttr": true, "docs": "Specifies the placement of the component", "docsTags": [], "default": "\"bottom\"", "values": [ { "value": "bottom", "type": "string" }, { "value": "bottom-end", "type": "string" }, { "value": "bottom-start", "type": "string" }, { "value": "top", "type": "string" }, { "value": "top-end", "type": "string" }, { "value": "top-start", "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteAlertBeforeClose", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is requested to be closed and before the closing transition begins.", "docsTags": [] }, { "event": "calciteAlertBeforeOpen", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is added to the DOM but not rendered, and before the opening transition begins.", "docsTags": [] }, { "event": "calciteAlertClose", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is closed and animation is complete.", "docsTags": [] }, { "event": "calciteAlertOpen", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is open and animation is complete.", "docsTags": [] } ], "listeners": [ { "event": "calciteInternalAlertSync", "target": "window", "capture": false, "passive": false }, { "event": "calciteInternalAlertRegister", "target": "window", "capture": false, "passive": false } ], "styles": [ { "name": "--calcite-alert-width", "annotation": "prop", "docs": "Specifies the width of the component." } ], "slots": [ { "name": "link", "docs": "A slot for optionally adding an action to take from the alert (undo, try again, link to page, etc.)" }, { "name": "message", "docs": "A slot for adding main text to the component." }, { "name": "title", "docs": "A slot for optionally adding a title to the component." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-icon", "calcite-chip" ], "dependencyGraph": { "calcite-alert": [ "calcite-icon", "calcite-chip" ], "calcite-chip": [ "calcite-icon" ] } }, { "filePath": "./src/components/avatar/avatar.tsx", "encapsulation": "shadow", "tag": "calcite-avatar", "readme": "# calcite-avatar\n\nThe avatar component provides a unique (but consistent) visual for a user. It's built\nto work with users returned from the ArcGIS REST API.\n", "docs": "The avatar component provides a unique (but consistent) visual for a user. It's built\nto work with users returned from the ArcGIS REST API.", "docsTags": [], "usage": { "Basic": "The JSON sample user below is returned from a [search for users](https://developers.arcgis.com/rest/users-groups-and-items/user-search.htm). You can create an avatar for Ron by passing these properties directly to the avatar component.\n\nWhen no thumbnail is provided, the avatar component will construct a useful placeholder, leveraging the user's information to construct a unique background-color with initials.\n\n**Note:** if your user is private, remember to append a token to the end of the thumbnail using the form `thumbnail.jpg?token=YOUR_LOGGED_IN_USER_TOKEN`.\n\n```json\n{\n \"username\": \"ron_swanson_pawnee\",\n \"id\": \"a81470986eaeee1833b74b7d8abcd5b2\",\n \"fullName\": \"Ron Swanson\",\n \"firstName\": \"Ron\",\n \"lastName\": \"Swanson\",\n \"thumbnail\": \"mySelf.jpg\",\n ...\n}\n```\n\n```html\n\n\n```\n" }, "props": [ { "name": "fullName", "type": "string", "mutable": false, "attr": "full-name", "reflectToAttr": true, "docs": "Specifies the full name of the user.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "thumbnail", "type": "string", "mutable": false, "attr": "thumbnail", "reflectToAttr": true, "docs": "Specifies the `src` to an image (remember to add a token if the user is private).", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "userId", "type": "string", "mutable": false, "attr": "user-id", "reflectToAttr": true, "docs": "Specifies the unique id of the user.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "username", "type": "string", "mutable": false, "attr": "username", "reflectToAttr": true, "docs": "Specifies the username of the user.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "calcite-icon" ], "dependencyGraph": { "calcite-avatar": [ "calcite-icon" ] } }, { "filePath": "./src/components/block/block.tsx", "encapsulation": "shadow", "tag": "calcite-block", "readme": "# calcite-block\n\nThe `calcite-block` component is intended for displaying a heading and content. Content can also include stacked, collapsible `calcite-block-section`s typically housed in a panel.\n", "docs": "The `calcite-block` component is intended for displaying a heading and content. Content can also include stacked, collapsible `calcite-block-section`s typically housed in a panel.", "docsTags": [ { "name": "slot", "text": "- A slot for adding content to the component." }, { "name": "slot", "text": "icon - A slot for adding a leading header icon with `calcite-icon`." }, { "name": "slot", "text": "control - A slot for adding a single HTML input element in a header." }, { "name": "slot", "text": "header-menu-actions - A slot for adding an overflow menu with `calcite-action`s inside a dropdown." } ], "usage": { "Always-open": "Renders a header and content that remains open - no collapsible option.\n\n```html\n\n
Father or Son?
\n
\n```\n", "Basic": "Renders a basic, non-collapsible block.\n\n```html\n \n```\n", "Collapsible": "Renders a header with a clickable icon to toggle the block open and closed.\n\n```html\n\n \n\n```\n", "Header-with-control": "Renders a header and control with a slot for adding a single HTML element (in the header).\n\n```html\n\n \n\n```\n", "Header-with-icon": "Renders a header and icon with the icon.\n\n```html\n\n
🤯
\n
\n```\n" }, "props": [ { "name": "collapsible", "type": "boolean", "mutable": false, "attr": "collapsible", "reflectToAttr": true, "docs": "When `true`, the component is collapsible.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": false, "docs": "A description for the component, which displays below the heading.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "disablePadding", "type": "boolean", "mutable": false, "attr": "disable-padding", "reflectToAttr": true, "docs": "When `true`, removes padding for the slotted content.", "docsTags": [ { "name": "deprecated", "text": "Use `--calcite-block-padding` CSS variable instead." } ], "default": "false", "deprecation": "Use `--calcite-block-padding` CSS variable instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "dragHandle", "type": "boolean", "mutable": false, "attr": "drag-handle", "reflectToAttr": true, "docs": "When `true`, displays a drag handle in the header.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "heading", "type": "string", "mutable": false, "attr": "heading", "reflectToAttr": false, "docs": "The component header text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "headingLevel", "type": "1 | 2 | 3 | 4 | 5 | 6", "mutable": false, "attr": "heading-level", "reflectToAttr": true, "docs": "Specifies the number at which section headings should start.", "docsTags": [], "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "optional": false, "required": false }, { "name": "intlCollapse", "type": "string", "mutable": false, "attr": "intl-collapse", "reflectToAttr": false, "docs": "Accessible name for the component's collapse button.", "docsTags": [ { "name": "default", "text": "\"Collapse\"" } ], "default": "TEXT.collapse", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlExpand", "type": "string", "mutable": false, "attr": "intl-expand", "reflectToAttr": false, "docs": "Accessible name for the component's expand button.", "docsTags": [ { "name": "default", "text": "\"Expand\"" } ], "default": "TEXT.expand", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlLoading", "type": "string", "mutable": false, "attr": "intl-loading", "reflectToAttr": false, "docs": "Accessible name when the component is loading.", "docsTags": [ { "name": "default", "text": "\"Loading\"" } ], "default": "TEXT.loading", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlOptions", "type": "string", "mutable": false, "attr": "intl-options", "reflectToAttr": false, "docs": "Accessible name for the component's options button.", "docsTags": [ { "name": "default", "text": "\"Options\"" } ], "default": "TEXT.options", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When `true`, a busy indicator is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "open", "type": "boolean", "mutable": true, "attr": "open", "reflectToAttr": true, "docs": "When `true`, expands the component and its contents.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "status", "type": "\"idle\" | \"invalid\" | \"valid\"", "mutable": false, "attr": "status", "reflectToAttr": true, "docs": "Displays a status-related indicator icon.", "docsTags": [], "values": [ { "value": "idle", "type": "string" }, { "value": "invalid", "type": "string" }, { "value": "valid", "type": "string" } ], "optional": true, "required": false }, { "name": "summary", "type": "string", "mutable": false, "attr": "summary", "reflectToAttr": false, "docs": "A description for the component, which displays below the heading.", "docsTags": [ { "name": "deprecated", "text": "use `description` instead" } ], "deprecation": "use `description` instead", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "calciteBlockToggle", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the component's header is clicked.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding content to the component." }, { "name": "control", "docs": "A slot for adding a single HTML input element in a header." }, { "name": "header-menu-actions", "docs": "A slot for adding an overflow menu with `calcite-action`s inside a dropdown." }, { "name": "icon", "docs": "A slot for adding a leading header icon with `calcite-icon`." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-scrim", "calcite-icon", "calcite-handle", "calcite-loader", "calcite-action-menu" ], "dependencyGraph": { "calcite-block": [ "calcite-scrim", "calcite-icon", "calcite-handle", "calcite-loader", "calcite-action-menu" ], "calcite-scrim": [ "calcite-loader" ], "calcite-handle": [ "calcite-icon" ], "calcite-action-menu": [ "calcite-action", "calcite-popover" ], "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-popover": [ "calcite-action", "calcite-icon" ] } }, { "filePath": "./src/components/block-section/block-section.tsx", "encapsulation": "shadow", "tag": "calcite-block-section", "readme": "# calcite-block-section\n\nThe `calcite-block-section` component is a child element of `calcite-block`. Sections can have their own header and content and can be toggled open or closed.\n", "docs": "The `calcite-block-section` component is a child element of `calcite-block`. Sections can have their own header and content and can be toggled open or closed.", "docsTags": [ { "name": "slot", "text": "- A slot for adding content to the component." } ], "usage": {}, "props": [ { "name": "intlCollapse", "type": "string", "mutable": false, "attr": "intl-collapse", "reflectToAttr": false, "docs": "Accessible name for the component's collapse button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlExpand", "type": "string", "mutable": false, "attr": "intl-expand", "reflectToAttr": false, "docs": "Accessible name for the component's expand button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "open", "type": "boolean", "mutable": true, "attr": "open", "reflectToAttr": true, "docs": "When `true`, expands the component and its contents.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "status", "type": "\"idle\" | \"invalid\" | \"valid\"", "mutable": false, "attr": "status", "reflectToAttr": true, "docs": "Displays a status-related indicator icon.", "docsTags": [], "values": [ { "value": "idle", "type": "string" }, { "value": "invalid", "type": "string" }, { "value": "valid", "type": "string" } ], "optional": true, "required": false }, { "name": "text", "type": "string", "mutable": false, "attr": "text", "reflectToAttr": false, "docs": "The component header text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "toggleDisplay", "type": "\"button\" | \"switch\"", "mutable": false, "attr": "toggle-display", "reflectToAttr": true, "docs": "Specifies the component's toggle display -\n\n`\"button\"` (selectable header), or\n\n`\"switch\"` (toggle switch).", "docsTags": [], "default": "\"button\"", "values": [ { "value": "button", "type": "string" }, { "value": "switch", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "calciteBlockSectionToggle", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the header has been clicked.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding content to the component." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-icon", "calcite-switch" ], "dependencyGraph": { "calcite-block-section": [ "calcite-icon", "calcite-switch" ] } }, { "filePath": "./src/components/button/button.tsx", "encapsulation": "shadow", "tag": "calcite-button", "readme": "# calcite-button\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding text." } ], "usage": { "Basic": "```html\nGo!\n```\n", "Focusing": "You can programmatically focus a `calcite-button` with the `setFocus()` method:\n\n```html\n
Focus!
\n```\n", "Internals": "Any additional attributes set on `` are passed to the internal `` or `\n \n \n \n \n\n```\n" }, "props": [], "methods": [ { "name": "back", "returns": { "type": "Promise", "docs": "" }, "signature": "back() => Promise", "parameters": [], "docs": "Removes the currently active `calcite-flow-item` or `calcite-panel`.", "docsTags": [] } ], "events": [], "listeners": [ { "event": "calciteFlowItemBackClick", "capture": false, "passive": false }, { "event": "calcitePanelBackClick", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-flow-item` or `calcite-panel`s (deprecated) to the flow." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/flow-item/flow-item.tsx", "encapsulation": "shadow", "tag": "calcite-flow-item", "readme": "# calcite-flow-item\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding custom content." }, { "name": "slot", "text": "header-actions-start - A slot for adding actions or content to the start side of the header." }, { "name": "slot", "text": "header-actions-end - A slot for adding actions or content to the end side of the header." }, { "name": "slot", "text": "header-content - A slot for adding custom content to the header." }, { "name": "slot", "text": "header-menu-actions - A slot for adding an overflow menu with actions inside a `calcite-dropdown`." }, { "name": "slot", "text": "fab - A slot for adding a `calcite-fab` (floating action button) to perform an action." }, { "name": "slot", "text": "footer-actions - A slot for adding buttons to the footer." }, { "name": "slot", "text": "footer - A slot for adding custom content to the footer." } ], "usage": {}, "props": [ { "name": "beforeBack", "type": "() => Promise", "mutable": false, "reflectToAttr": false, "docs": "When provided, this method will be called before it is removed from the parent flow.", "docsTags": [], "values": [ { "type": "() => Promise" } ], "optional": true, "required": false }, { "name": "closable", "type": "boolean", "mutable": true, "attr": "closable", "reflectToAttr": true, "docs": "When true, displays a close button in the trailing side of the header", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "closed", "type": "boolean", "mutable": true, "attr": "closed", "reflectToAttr": true, "docs": "When true, flow-item will be hidden", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": false, "docs": "A description for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When true, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "heading", "type": "string", "mutable": false, "attr": "heading", "reflectToAttr": false, "docs": "The component header text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "1 | 2 | 3 | 4 | 5 | 6", "mutable": false, "attr": "heading-level", "reflectToAttr": true, "docs": "Specifies the number at which section headings should start.", "docsTags": [], "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "optional": false, "required": false }, { "name": "heightScale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "height-scale", "reflectToAttr": true, "docs": "Specifies the maximum height of the component.", "docsTags": [], "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false }, { "name": "intlBack", "type": "string", "mutable": false, "attr": "intl-back", "reflectToAttr": false, "docs": "Accessible name for the component's back button. The back button will only be shown when 'showBackButton' is true.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlClose", "type": "string", "mutable": false, "attr": "intl-close", "reflectToAttr": false, "docs": "Accessible name for the component's close button. The close button will only be shown when 'dismissible' is true.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlOptions", "type": "string", "mutable": false, "attr": "intl-options", "reflectToAttr": false, "docs": "Accessible name for the component's actions menu.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When true, a busy indicator is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "menuOpen", "type": "boolean", "mutable": false, "attr": "menu-open", "reflectToAttr": true, "docs": "When true, the action menu items in the `header-menu-actions` slot are open.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "showBackButton", "type": "boolean", "mutable": false, "attr": "show-back-button", "reflectToAttr": true, "docs": "When true, displays a back button in the header.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "widthScale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "width-scale", "reflectToAttr": true, "docs": "Specifies the width of the component.", "docsTags": [], "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false } ], "methods": [ { "name": "scrollContentTo", "returns": { "type": "Promise", "docs": "" }, "signature": "scrollContentTo(options?: ScrollToOptions) => Promise", "parameters": [], "docs": "Scrolls the component's content to a specified set of coordinates.", "docsTags": [ { "name": "example", "text": "myCalciteFlowItem.scrollContentTo({\n left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.\n top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element\n behavior: \"auto\" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).\n});" }, { "name": "param", "text": "options" } ] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteFlowItemBack", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the back button is clicked.", "docsTags": [] }, { "event": "calciteFlowItemBackClick", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the back button is clicked.", "docsTags": [ { "name": "deprecated", "text": "use calciteFlowItemBack instead." } ], "deprecation": "use calciteFlowItemBack instead." }, { "event": "calciteFlowItemClose", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the close button is clicked.", "docsTags": [] }, { "event": "calciteFlowItemScroll", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the content is scrolled.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding custom content." }, { "name": "fab", "docs": "A slot for adding a `calcite-fab` (floating action button) to perform an action." }, { "name": "footer", "docs": "A slot for adding custom content to the footer." }, { "name": "footer-actions", "docs": "A slot for adding buttons to the footer." }, { "name": "header-actions-end", "docs": "A slot for adding actions or content to the end side of the header." }, { "name": "header-actions-start", "docs": "A slot for adding actions or content to the start side of the header." }, { "name": "header-content", "docs": "A slot for adding custom content to the header." }, { "name": "header-menu-actions", "docs": "A slot for adding an overflow menu with actions inside a `calcite-dropdown`." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-action", "calcite-panel", "calcite-tooltip" ], "dependencyGraph": { "calcite-flow-item": [ "calcite-action", "calcite-panel", "calcite-tooltip" ], "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-panel": [ "calcite-action", "calcite-action-menu", "calcite-scrim" ], "calcite-action-menu": [ "calcite-action", "calcite-popover" ], "calcite-popover": [ "calcite-action", "calcite-icon" ], "calcite-scrim": [ "calcite-loader" ] } }, { "filePath": "./src/components/graph/graph.tsx", "encapsulation": "shadow", "tag": "calcite-graph", "readme": "# calcite-graph\n\nThe graph component is used to show small, lightweight graphs in places where a full interactive chart is not needed. This includes sparklines, histograms, and small trend plots.\n", "docs": "The graph component is used to show small, lightweight graphs in places where a full interactive chart is not needed. This includes sparklines, histograms, and small trend plots.", "docsTags": [], "usage": {}, "props": [ { "name": "colorStops", "type": "ColorStop[]", "mutable": false, "reflectToAttr": false, "docs": "Array of values describing a single color stop ([offset, color, opacity])\nThese color stops should be sorted by offset value", "docsTags": [], "values": [ { "type": "ColorStop[]" } ], "optional": false, "required": false }, { "name": "data", "type": "Point[]", "mutable": false, "reflectToAttr": false, "docs": "Array of tuples describing a single data point ([x, y])\nThese data points should be sorted by x-axis value", "docsTags": [], "default": "[]", "values": [ { "type": "Point[]" } ], "optional": false, "required": false }, { "name": "highlightMax", "type": "number", "mutable": false, "attr": "highlight-max", "reflectToAttr": false, "docs": "End of highlight color if highlighting range", "docsTags": [], "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "highlightMin", "type": "number", "mutable": false, "attr": "highlight-min", "reflectToAttr": false, "docs": "Start of highlight color if highlighting range", "docsTags": [], "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "max", "type": "number", "mutable": false, "attr": "max", "reflectToAttr": true, "docs": "Highest point of the range", "docsTags": [], "values": [ { "type": "number" } ], "optional": false, "required": true }, { "name": "min", "type": "number", "mutable": false, "attr": "min", "reflectToAttr": true, "docs": "Lowest point of the range", "docsTags": [], "values": [ { "type": "number" } ], "optional": false, "required": true } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "calcite-slider" ], "dependencies": [], "dependencyGraph": { "calcite-slider": [ "calcite-graph" ] } }, { "filePath": "./src/components/handle/handle.tsx", "encapsulation": "shadow", "tag": "calcite-handle", "readme": "# calcite-handle\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "textTitle", "type": "string", "mutable": false, "attr": "text-title", "reflectToAttr": true, "docs": "Value for the button title attribute", "docsTags": [], "default": "\"handle\"", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteHandleNudge", "detail": "any", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emitted when the handle is activated and the up or down arrow key is pressed.\n\n**Note:**: The `handle` event payload prop is deprecated, please use the event's `target`/`currentTarget` instead", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "calcite-block" ], "dependencies": [ "calcite-icon" ], "dependencyGraph": { "calcite-handle": [ "calcite-icon" ], "calcite-block": [ "calcite-handle" ] } }, { "filePath": "./src/components/icon/icon.tsx", "encapsulation": "shadow", "tag": "calcite-icon", "readme": "# calcite-icon\n", "docs": "", "docsTags": [], "usage": { "Custom-icon-color": "To use a custom color for the icon fill, you can add a class to the `calcite-icon` component with the desired color.\n\n```html\n\n```\n\n```css\n.my-icon-color-class {\n color: #007ac2;\n}\n```\n" }, "props": [ { "name": "flipRtl", "type": "boolean", "mutable": false, "attr": "flip-rtl", "reflectToAttr": true, "docs": "When true, the icon will be flipped when the element direction is 'rtl'.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "icon", "type": "string", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "The name of the icon to display. The value of this property must match the icon name from https://esri.github.io/calcite-ui-icons/.", "docsTags": [], "default": "null", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Icon scale.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "textLabel", "type": "string", "mutable": false, "attr": "text-label", "reflectToAttr": false, "docs": "The icon label.\n\nIt is recommended to set this value if your icon is semantic.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--calcite-ui-icon-color", "annotation": "prop", "docs": "the color of the icon. Defaults to 'currentColor'." } ], "slots": [], "parts": [], "dependents": [ "calcite-accordion-item", "calcite-action", "calcite-alert", "calcite-avatar", "calcite-block", "calcite-block-section", "calcite-button", "calcite-chip", "calcite-combobox", "calcite-combobox-item", "calcite-date-picker-month-header", "calcite-dropdown-item", "calcite-handle", "calcite-input", "calcite-input-date-picker", "calcite-input-message", "calcite-input-number", "calcite-input-text", "calcite-link", "calcite-modal", "calcite-notice", "calcite-pagination", "calcite-pick-list-item", "calcite-popover", "calcite-radio-group-item", "calcite-rating", "calcite-select", "calcite-stepper-item", "calcite-tab-title", "calcite-tile", "calcite-time-picker", "calcite-tip-manager", "calcite-tree-item", "calcite-value-list-item" ], "dependencies": [], "dependencyGraph": { "calcite-accordion-item": [ "calcite-icon" ], "calcite-action": [ "calcite-icon" ], "calcite-alert": [ "calcite-icon" ], "calcite-avatar": [ "calcite-icon" ], "calcite-block": [ "calcite-icon" ], "calcite-block-section": [ "calcite-icon" ], "calcite-button": [ "calcite-icon" ], "calcite-chip": [ "calcite-icon" ], "calcite-combobox": [ "calcite-icon" ], "calcite-combobox-item": [ "calcite-icon" ], "calcite-date-picker-month-header": [ "calcite-icon" ], "calcite-dropdown-item": [ "calcite-icon" ], "calcite-handle": [ "calcite-icon" ], "calcite-input": [ "calcite-icon" ], "calcite-input-date-picker": [ "calcite-icon" ], "calcite-input-message": [ "calcite-icon" ], "calcite-input-number": [ "calcite-icon" ], "calcite-input-text": [ "calcite-icon" ], "calcite-link": [ "calcite-icon" ], "calcite-modal": [ "calcite-icon" ], "calcite-notice": [ "calcite-icon" ], "calcite-pagination": [ "calcite-icon" ], "calcite-pick-list-item": [ "calcite-icon" ], "calcite-popover": [ "calcite-icon" ], "calcite-radio-group-item": [ "calcite-icon" ], "calcite-rating": [ "calcite-icon" ], "calcite-select": [ "calcite-icon" ], "calcite-stepper-item": [ "calcite-icon" ], "calcite-tab-title": [ "calcite-icon" ], "calcite-tile": [ "calcite-icon" ], "calcite-time-picker": [ "calcite-icon" ], "calcite-tip-manager": [ "calcite-icon" ], "calcite-tree-item": [ "calcite-icon" ], "calcite-value-list-item": [ "calcite-icon" ] } }, { "filePath": "./src/components/inline-editable/inline-editable.tsx", "encapsulation": "shadow", "tag": "calcite-inline-editable", "readme": "# calcite-inline-editable\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding a `calcite-input`." } ], "usage": { "Basic": "There is no need to set a theme or scale on the `` component, as it inherits these values from the wrapped ``, or the closest parent component where these props are set.\n\n```html\n\n \n\n```\n", "With-label": "```html\n\n My great label\n \n \n \n\n```\n", "With-save-and-cancel-controls": "```html\n\n \n\n```\n" }, "props": [ { "name": "afterConfirm", "type": "() => Promise", "mutable": false, "reflectToAttr": false, "docs": "when controls, specify a callback to be executed prior to disabling editing. when provided, loading state will be handled automatically.", "docsTags": [], "values": [ { "type": "() => Promise" } ], "optional": true, "required": false }, { "name": "controls", "type": "boolean", "mutable": false, "attr": "controls", "reflectToAttr": true, "docs": "specify whether save/cancel controls should be displayed when editingEnabled is true, defaults to false", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "specify whether editing can be enabled", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "editingEnabled", "type": "boolean", "mutable": true, "attr": "editing-enabled", "reflectToAttr": true, "docs": "specify whether the wrapped input element is editable, defaults to false", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "intlCancelEditing", "type": "string", "mutable": false, "attr": "intl-cancel-editing", "reflectToAttr": true, "docs": "specify text to be user for the cancel editing button's aria-label, defaults to `Cancel`", "docsTags": [ { "name": "default", "text": "\"Cancel\"" } ], "default": "TEXT.intlCancelEditing", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlConfirmChanges", "type": "string", "mutable": false, "attr": "intl-confirm-changes", "reflectToAttr": true, "docs": "specify text to be user for the confirm changes button's aria-label, defaults to `Save`", "docsTags": [ { "name": "default", "text": "\"Save\"" } ], "default": "TEXT.intlConfirmChanges", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlEnableEditing", "type": "string", "mutable": false, "attr": "intl-enable-editing", "reflectToAttr": true, "docs": "specify text to be user for the enable editing button's aria-label, defaults to `Click to edit`", "docsTags": [ { "name": "default", "text": "\"Click to edit\"" } ], "default": "TEXT.intlEnablingEditing", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "loading", "type": "boolean", "mutable": true, "attr": "loading", "reflectToAttr": true, "docs": "specify whether the confirm button should display a loading state, defaults to false", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": true, "attr": "scale", "reflectToAttr": true, "docs": "specify the scale of the inline-editable component, defaults to the scale of the wrapped calcite-input or the scale of the closest wrapping component with a set scale", "docsTags": [], "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "calciteInlineEditableEditCancel", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emitted when the cancel button gets clicked.", "docsTags": [] }, { "event": "calciteInlineEditableEditConfirm", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emitted when the check button gets clicked.", "docsTags": [] } ], "listeners": [ { "event": "calciteInternalInputBlur", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding a `calcite-input`." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-button" ], "dependencyGraph": { "calcite-inline-editable": [ "calcite-button" ], "calcite-button": [ "calcite-loader", "calcite-icon" ] } }, { "filePath": "./src/components/input/input.tsx", "encapsulation": "shadow", "tag": "calcite-input", "readme": "# calcite-input\n", "docs": "", "docsTags": [ { "name": "slot", "text": "action - A slot for positioning a `calcite-button` next to the component." } ], "usage": { "Basic": "```html\n\n```\n", "Clearable": "```html\n\n Clearable item\n \n\n```\n", "Native-events": "You can also listen for native events emitted from ``.\n\nYou must use `focusin`/`focusout` instead of `focus`/`blur` because these events bubble up from the rendered child element rendered inside of ``\n\nAll events return an element and a value:\n\n```js\ninput.addEventListener(\"focusin\", logFocus);\ninput.addEventListener(\"focusout\", logBlur);\n\nfunction logChange() {\n console.log(event.target.element);\n console.log(event.target.value);\n}\n```\n", "With-label": "Using a wrapping `calcite-label` component lets consumers set the status attribute once and have it propagate to child `calcite-input` and `calcite-input-message` elements\n\n```html\n\n Invalid input\n \n Something doesn't look right \n\n```\n", "With-message": "```html\n\n My great label\n \n \n Here's something you should know about this input\n \n\n```\n" }, "props": [ { "name": "alignment", "type": "\"end\" | \"start\"", "mutable": false, "attr": "alignment", "reflectToAttr": true, "docs": "Specifies the text alignment of the component's value.", "docsTags": [], "default": "\"start\"", "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": false, "required": false }, { "name": "autofocus", "type": "boolean", "mutable": false, "attr": "autofocus", "reflectToAttr": true, "docs": "When `true`, the component is focused on page load.", "docsTags": [ { "name": "mdn", "text": "[autofocus](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "clearable", "type": "boolean", "mutable": false, "attr": "clearable", "reflectToAttr": true, "docs": "When `true`, a clear button is displayed when the component has a value. The clear button shows by default for `\"search\"`, `\"time\"`, and `\"date\"` types, and will not display for the `\"textarea\"` type.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [ { "name": "mdn", "text": "[disabled](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "groupSeparator", "type": "boolean", "mutable": false, "attr": "group-separator", "reflectToAttr": true, "docs": "When `true`, number values are displayed with a group separator corresponding to the language and country format.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "hidden", "type": "boolean", "mutable": false, "attr": "hidden", "reflectToAttr": true, "docs": "When `true`, the component will not be visible.", "docsTags": [ { "name": "mdn", "text": "[hidden](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/hidden)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "icon", "type": "boolean | string", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon.", "docsTags": [], "values": [ { "type": "boolean" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "iconFlipRtl", "type": "boolean", "mutable": false, "attr": "icon-flip-rtl", "reflectToAttr": true, "docs": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`).", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "intlClear", "type": "string", "mutable": false, "attr": "intl-clear", "reflectToAttr": false, "docs": "Accessible name for the component's clear button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlLoading", "type": "string", "mutable": false, "attr": "intl-loading", "reflectToAttr": false, "docs": "Accessible name when the component is loading.", "docsTags": [ { "name": "default", "text": "\"Loading\"" } ], "default": "COMMON_TEXT.loading", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Accessible name for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When `true`, a busy indicator is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "locale", "type": "string", "mutable": false, "attr": "locale", "reflectToAttr": false, "docs": "BCP 47 language tag for desired language and country format", "docsTags": [ { "name": "deprecated", "text": "set the global `lang` attribute on the element instead." }, { "name": "mdn", "text": "[lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)" } ], "deprecation": "set the global `lang` attribute on the element instead.", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "max", "type": "number", "mutable": false, "attr": "max", "reflectToAttr": true, "docs": "Specifies the maximum value for type \"number\".", "docsTags": [ { "name": "mdn", "text": "[max](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max)" } ], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "maxLength", "type": "number", "mutable": false, "attr": "max-length", "reflectToAttr": true, "docs": "Specifies the maximum length of text for the component's value.", "docsTags": [ { "name": "mdn", "text": "[maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength)" } ], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "maxlength", "type": "number", "mutable": false, "attr": "maxlength", "reflectToAttr": true, "docs": "Specifies the maximum length of text for the component's value.", "docsTags": [ { "name": "deprecated", "text": "use `maxLength` instead." } ], "deprecation": "use `maxLength` instead.", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "min", "type": "number", "mutable": false, "attr": "min", "reflectToAttr": true, "docs": "Specifies the minimum value for `type=\"number\"`.", "docsTags": [ { "name": "mdn", "text": "[min](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min)" } ], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "minLength", "type": "number", "mutable": false, "attr": "min-length", "reflectToAttr": true, "docs": "Specifies the minimum length of text for the component's value.", "docsTags": [ { "name": "mdn", "text": "[minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength)" } ], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component on form submission.", "docsTags": [ { "name": "mdn", "text": "[name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)" } ], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "numberButtonType", "type": "\"horizontal\" | \"none\" | \"vertical\"", "mutable": false, "attr": "number-button-type", "reflectToAttr": true, "docs": "Specifies the placement of the buttons for `type=\"number\"`.", "docsTags": [], "default": "\"vertical\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "none", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": true, "required": false }, { "name": "numberingSystem", "type": "\"arab\" | \"arabext\" | \"bali\" | \"beng\" | \"deva\" | \"fullwide\" | \"gujr\" | \"guru\" | \"hanidec\" | \"khmr\" | \"knda\" | \"laoo\" | \"latn\" | \"limb\" | \"mlym\" | \"mong\" | \"mymr\" | \"orya\" | \"tamldec\" | \"telu\" | \"thai\" | \"tibt\"", "mutable": false, "attr": "numbering-system", "reflectToAttr": true, "docs": "Specifies the Unicode numeral system used by the component for localization.", "docsTags": [], "values": [ { "value": "arab", "type": "string" }, { "value": "arabext", "type": "string" }, { "value": "bali", "type": "string" }, { "value": "beng", "type": "string" }, { "value": "deva", "type": "string" }, { "value": "fullwide", "type": "string" }, { "value": "gujr", "type": "string" }, { "value": "guru", "type": "string" }, { "value": "hanidec", "type": "string" }, { "value": "khmr", "type": "string" }, { "value": "knda", "type": "string" }, { "value": "laoo", "type": "string" }, { "value": "latn", "type": "string" }, { "value": "limb", "type": "string" }, { "value": "mlym", "type": "string" }, { "value": "mong", "type": "string" }, { "value": "mymr", "type": "string" }, { "value": "orya", "type": "string" }, { "value": "tamldec", "type": "string" }, { "value": "telu", "type": "string" }, { "value": "thai", "type": "string" }, { "value": "tibt", "type": "string" } ], "optional": true, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "Specifies placeholder text for the component.", "docsTags": [ { "name": "mdn", "text": "[placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder)" } ], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "prefixText", "type": "string", "mutable": false, "attr": "prefix-text", "reflectToAttr": false, "docs": "Adds text to the start of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "readOnly", "type": "boolean", "mutable": false, "attr": "read-only", "reflectToAttr": true, "docs": "When `true`, the component's value can be read, but cannot be modified.", "docsTags": [ { "name": "mdn", "text": "[readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": true, "docs": "When `true`, the component must have a value in order for the form to submit.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": true, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "status", "type": "\"idle\" | \"invalid\" | \"valid\"", "mutable": true, "attr": "status", "reflectToAttr": true, "docs": "Specifies the status of the input field, which determines message and icons.", "docsTags": [], "default": "\"idle\"", "values": [ { "value": "idle", "type": "string" }, { "value": "invalid", "type": "string" }, { "value": "valid", "type": "string" } ], "optional": false, "required": false }, { "name": "step", "type": "\"any\" | number", "mutable": false, "attr": "step", "reflectToAttr": true, "docs": "Specifies the granularity the component's value must adhere to.", "docsTags": [ { "name": "mdn", "text": "[step](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step)" } ], "values": [ { "value": "any", "type": "string" }, { "type": "number" } ], "optional": true, "required": false }, { "name": "suffixText", "type": "string", "mutable": false, "attr": "suffix-text", "reflectToAttr": false, "docs": "Adds text to the end of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "type", "type": "\"color\" | \"date\" | \"datetime-local\" | \"email\" | \"file\" | \"image\" | \"month\" | \"number\" | \"password\" | \"search\" | \"tel\" | \"text\" | \"textarea\" | \"time\" | \"url\" | \"week\"", "mutable": false, "attr": "type", "reflectToAttr": true, "docs": "Specifies the component type.\n\nNote that the following `type`s add type-specific icons by default: `\"date\"`, `\"email\"`, `\"password\"`, `\"search\"`, `\"tel\"`, `\"time\"`.", "docsTags": [], "default": "\"text\"", "values": [ { "value": "color", "type": "string" }, { "value": "date", "type": "string" }, { "value": "datetime-local", "type": "string" }, { "value": "email", "type": "string" }, { "value": "file", "type": "string" }, { "value": "image", "type": "string" }, { "value": "month", "type": "string" }, { "value": "number", "type": "string" }, { "value": "password", "type": "string" }, { "value": "search", "type": "string" }, { "value": "tel", "type": "string" }, { "value": "text", "type": "string" }, { "value": "textarea", "type": "string" }, { "value": "time", "type": "string" }, { "value": "url", "type": "string" }, { "value": "week", "type": "string" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The component's value.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "selectText", "returns": { "type": "Promise", "docs": "" }, "signature": "selectText() => Promise", "parameters": [], "docs": "Selects all text of the component's `value`.", "docsTags": [] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteInputChange", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires each time a new `value` is typed and committed.", "docsTags": [] }, { "event": "calciteInputInput", "detail": "any", "bubbles": true, "cancelable": true, "composed": true, "docs": "Fires each time a new `value` is typed.\n\n**Note:**: The `el` and `value` event payload properties are deprecated, use the event's `target`/`currentTarget` instead.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "action", "docs": "A slot for positioning a `calcite-button` next to the component." } ], "parts": [], "dependents": [ "calcite-color-picker", "calcite-color-picker-hex-input", "calcite-filter", "calcite-input-date-picker", "calcite-input-time-picker" ], "dependencies": [ "calcite-progress", "calcite-icon" ], "dependencyGraph": { "calcite-input": [ "calcite-progress", "calcite-icon" ], "calcite-color-picker": [ "calcite-input" ], "calcite-color-picker-hex-input": [ "calcite-input" ], "calcite-filter": [ "calcite-input" ], "calcite-input-date-picker": [ "calcite-input" ], "calcite-input-time-picker": [ "calcite-input" ] } }, { "filePath": "./src/components/input-date-picker/input-date-picker.tsx", "encapsulation": "shadow", "tag": "calcite-input-date-picker", "readme": "# calcite-input-date-picker\n", "docs": "", "docsTags": [], "usage": { "Basic": "```html\n
\n \n Date\n \n \n
\n```\n" }, "props": [ { "name": "active", "type": "boolean", "mutable": true, "attr": "active", "reflectToAttr": true, "docs": "When `true`, the component is active.", "docsTags": [ { "name": "deprecated", "text": "use `open` instead." } ], "default": "false", "deprecation": "use `open` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "end", "type": "string", "mutable": true, "attr": "end", "reflectToAttr": true, "docs": "The component's end date.", "docsTags": [ { "name": "deprecated", "text": "use `value` instead." } ], "deprecation": "use `value` instead.", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "endAsDate", "type": "Date", "mutable": true, "reflectToAttr": false, "docs": "The component's end date as a full date object.", "docsTags": [ { "name": "deprecated", "text": "use `valueAsDate` instead." } ], "deprecation": "use `valueAsDate` instead.", "values": [ { "type": "Date" } ], "optional": true, "required": false }, { "name": "flipPlacements", "type": "Placement[]", "mutable": false, "reflectToAttr": false, "docs": "Defines the available placements that can be used when a flip occurs.", "docsTags": [], "values": [ { "type": "Placement[]" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "1 | 2 | 3 | 4 | 5 | 6", "mutable": false, "attr": "heading-level", "reflectToAttr": true, "docs": "Specifies the number at which section headings should start.", "docsTags": [], "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "optional": false, "required": false }, { "name": "intlNextMonth", "type": "string", "mutable": false, "attr": "intl-next-month", "reflectToAttr": false, "docs": "Accessible name for the component's next month button.", "docsTags": [ { "name": "default", "text": "\"Next month\"" } ], "default": "TEXT.nextMonth", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlPrevMonth", "type": "string", "mutable": false, "attr": "intl-prev-month", "reflectToAttr": false, "docs": "Accessible name for the component's previous month button.", "docsTags": [ { "name": "default", "text": "\"Previous month\"" } ], "default": "TEXT.prevMonth", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlYear", "type": "string", "mutable": false, "attr": "intl-year", "reflectToAttr": false, "docs": "Accessible name for the component's year input.", "docsTags": [ { "name": "default", "text": "\"Year\"" } ], "default": "TEXT.year", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layout", "type": "\"horizontal\" | \"vertical\"", "mutable": false, "attr": "layout", "reflectToAttr": true, "docs": "Defines the layout of the component.", "docsTags": [], "default": "\"horizontal\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": false, "required": false }, { "name": "locale", "type": "string", "mutable": false, "attr": "locale", "reflectToAttr": false, "docs": "Specifies the BCP 47 language tag for the desired language and country format.", "docsTags": [ { "name": "deprecated", "text": "set the global `lang` attribute on the element instead." }, { "name": "mdn", "text": "[lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)" } ], "deprecation": "set the global `lang` attribute on the element instead.", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "max", "type": "string", "mutable": true, "attr": "max", "reflectToAttr": false, "docs": "Specifies the latest allowed date (\"yyyy-mm-dd\").", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "maxAsDate", "type": "Date", "mutable": true, "reflectToAttr": false, "docs": "Specifies the latest allowed date as a full date object.", "docsTags": [], "values": [ { "type": "Date" } ], "optional": true, "required": false }, { "name": "min", "type": "string", "mutable": true, "attr": "min", "reflectToAttr": false, "docs": "Specifies the earliest allowed date (\"yyyy-mm-dd\").", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "minAsDate", "type": "Date", "mutable": true, "reflectToAttr": false, "docs": "Specifies the earliest allowed date as a full date object.", "docsTags": [], "values": [ { "type": "Date" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component on form submission.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "numberingSystem", "type": "\"arab\" | \"arabext\" | \"bali\" | \"beng\" | \"deva\" | \"fullwide\" | \"gujr\" | \"guru\" | \"hanidec\" | \"khmr\" | \"knda\" | \"laoo\" | \"latn\" | \"limb\" | \"mlym\" | \"mong\" | \"mymr\" | \"orya\" | \"tamldec\" | \"telu\" | \"thai\" | \"tibt\"", "mutable": false, "attr": "numbering-system", "reflectToAttr": true, "docs": "Specifies the Unicode numeral system used by the component for localization. This property cannot be dynamically changed.", "docsTags": [], "values": [ { "value": "arab", "type": "string" }, { "value": "arabext", "type": "string" }, { "value": "bali", "type": "string" }, { "value": "beng", "type": "string" }, { "value": "deva", "type": "string" }, { "value": "fullwide", "type": "string" }, { "value": "gujr", "type": "string" }, { "value": "guru", "type": "string" }, { "value": "hanidec", "type": "string" }, { "value": "khmr", "type": "string" }, { "value": "knda", "type": "string" }, { "value": "laoo", "type": "string" }, { "value": "latn", "type": "string" }, { "value": "limb", "type": "string" }, { "value": "mlym", "type": "string" }, { "value": "mong", "type": "string" }, { "value": "mymr", "type": "string" }, { "value": "orya", "type": "string" }, { "value": "tamldec", "type": "string" }, { "value": "telu", "type": "string" }, { "value": "thai", "type": "string" }, { "value": "tibt", "type": "string" } ], "optional": true, "required": false }, { "name": "open", "type": "boolean", "mutable": true, "attr": "open", "reflectToAttr": true, "docs": "When `true`, displays the `calcite-date-picker` component.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "overlayPositioning", "type": "\"absolute\" | \"fixed\"", "mutable": false, "attr": "overlay-positioning", "reflectToAttr": true, "docs": "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\"`.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "type": "string" } ], "optional": false, "required": false }, { "name": "placement", "type": "\"bottom\" | \"bottom-end\" | \"bottom-leading\" | \"bottom-start\" | \"bottom-trailing\" | \"top\" | \"top-end\" | \"top-leading\" | \"top-start\" | \"top-trailing\"", "mutable": false, "attr": "placement", "reflectToAttr": true, "docs": "Specifies the placement of the `calcite-date-picker` relative to the component.", "docsTags": [ { "name": "default", "text": "\"bottom-start\"" } ], "default": "defaultMenuPlacement", "values": [ { "value": "bottom", "type": "string" }, { "value": "bottom-end", "type": "string" }, { "value": "bottom-leading", "type": "string" }, { "value": "bottom-start", "type": "string" }, { "value": "bottom-trailing", "type": "string" }, { "value": "top", "type": "string" }, { "value": "top-end", "type": "string" }, { "value": "top-leading", "type": "string" }, { "value": "top-start", "type": "string" }, { "value": "top-trailing", "type": "string" } ], "optional": false, "required": false }, { "name": "proximitySelectionDisabled", "type": "boolean", "mutable": false, "attr": "proximity-selection-disabled", "reflectToAttr": false, "docs": "When `true`, disables the default behavior on the third click of narrowing or extending the range.\nInstead starts a new range.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "range", "type": "boolean", "mutable": false, "attr": "range", "reflectToAttr": true, "docs": "When `true`, activates a range for the component.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "readOnly", "type": "boolean", "mutable": false, "attr": "read-only", "reflectToAttr": true, "docs": "When `true`, the component's value can be read, but controls are not accessible and the value cannot be modified.", "docsTags": [ { "name": "mdn", "text": "[readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "start", "type": "string", "mutable": true, "attr": "start", "reflectToAttr": true, "docs": "The component's start date.", "docsTags": [ { "name": "deprecated", "text": "use `value` instead." } ], "deprecation": "use `value` instead.", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "startAsDate", "type": "Date", "mutable": true, "reflectToAttr": false, "docs": "The component's start date as a full date object.", "docsTags": [ { "name": "deprecated", "text": "use `valueAsDate` instead." } ], "deprecation": "use `valueAsDate` instead.", "values": [ { "type": "Date" } ], "optional": true, "required": false }, { "name": "value", "type": "string | string[]", "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The component's value.", "docsTags": [], "values": [ { "type": "string" }, { "type": "string[]" } ], "optional": false, "required": false }, { "name": "valueAsDate", "type": "Date | Date[]", "mutable": true, "reflectToAttr": false, "docs": "The component's value as a full date object.", "docsTags": [], "values": [ { "type": "Date" }, { "type": "Date[]" } ], "optional": true, "required": false } ], "methods": [ { "name": "reposition", "returns": { "type": "Promise", "docs": "" }, "signature": "reposition(delayed?: boolean) => Promise", "parameters": [], "docs": "Updates the position of the component.", "docsTags": [ { "name": "param", "text": "delayed" } ] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteDatePickerChange", "detail": "Date", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when a user changes the date.", "docsTags": [ { "name": "deprecated", "text": "use `calciteInputDatePickerChange` instead." } ], "deprecation": "use `calciteInputDatePickerChange` instead." }, { "event": "calciteDatePickerRangeChange", "detail": "DateRangeChange", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when a user changes the date range.", "docsTags": [ { "name": "see", "text": "[DateRangeChange](https://github.com/Esri/calcite-components/blob/master/src/components/date-picker/interfaces.ts#L1)" }, { "name": "deprecated", "text": "use `calciteInputDatePickerChange` instead." } ], "deprecation": "use `calciteInputDatePickerChange` instead." }, { "event": "calciteInputDatePickerBeforeClose", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is requested to be closed and before the closing transition begins.", "docsTags": [] }, { "event": "calciteInputDatePickerBeforeOpen", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is added to the DOM but not rendered, and before the opening transition begins.", "docsTags": [] }, { "event": "calciteInputDatePickerChange", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component's value changes.", "docsTags": [] }, { "event": "calciteInputDatePickerClose", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is closed and animation is complete.", "docsTags": [] }, { "event": "calciteInputDatePickerOpen", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is open and animation is complete.", "docsTags": [] } ], "listeners": [ { "event": "calciteDatePickerChange", "capture": false, "passive": false }, { "event": "calciteDatePickerRangeChange", "capture": false, "passive": false }, { "event": "calciteDaySelect", "capture": false, "passive": false } ], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "calcite-input", "calcite-date-picker", "calcite-icon" ], "dependencyGraph": { "calcite-input-date-picker": [ "calcite-input", "calcite-date-picker", "calcite-icon" ], "calcite-input": [ "calcite-progress", "calcite-icon" ], "calcite-date-picker": [ "calcite-date-picker-month-header", "calcite-date-picker-month" ], "calcite-date-picker-month-header": [ "calcite-icon" ], "calcite-date-picker-month": [ "calcite-date-picker-day" ] } }, { "filePath": "./src/components/input-message/input-message.tsx", "encapsulation": "shadow", "tag": "calcite-input-message", "readme": "# calcite-input-message\n\nDisplays a contextual message to a user. Allows the passing of content, links, etc.\n", "docs": "Displays a contextual message to a user. Allows the passing of content, links, etc.", "docsTags": [ { "name": "slot", "text": "- A slot for adding text." } ], "usage": { "Basic": "```html\n\n My great label\n \n That's not going to work out.\n Learn more\n\n```\n" }, "props": [ { "name": "active", "type": "boolean", "mutable": false, "attr": "active", "reflectToAttr": true, "docs": "When `true`, the component is active.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "icon", "type": "boolean | string", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "Specifies an icon to display.", "docsTags": [], "values": [ { "type": "boolean" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": true, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "status", "type": "\"idle\" | \"invalid\" | \"valid\"", "mutable": true, "attr": "status", "reflectToAttr": true, "docs": "Specifies the status of the input field, which determines message and icons.", "docsTags": [], "default": "\"idle\"", "values": [ { "value": "idle", "type": "string" }, { "value": "invalid", "type": "string" }, { "value": "valid", "type": "string" } ], "optional": false, "required": false }, { "name": "type", "type": "\"default\"", "mutable": false, "attr": "type", "reflectToAttr": true, "docs": "Specifies the appearance of a slotted message - `\"default\"` (displayed under the component), or `\"floating\"` (positioned absolutely under the component).", "docsTags": [ { "name": "deprecated", "text": "The `\"floating\"` type is no longer supported." } ], "deprecation": "The `\"floating\"` type is no longer supported.", "values": [ { "value": "default", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--calcite-input-message-spacing-value", "annotation": "prop", "docs": "The top margin spacing above the component." } ], "slots": [ { "name": "", "docs": "A slot for adding text." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-icon" ], "dependencyGraph": { "calcite-input-message": [ "calcite-icon" ] } }, { "filePath": "./src/components/input-number/input-number.tsx", "encapsulation": "shadow", "tag": "calcite-input-number", "readme": "# calcite-input-number\n", "docs": "", "docsTags": [ { "name": "slot", "text": "action - A slot for positioning a button next to the component." } ], "usage": {}, "props": [ { "name": "alignment", "type": "\"end\" | \"start\"", "mutable": false, "attr": "alignment", "reflectToAttr": true, "docs": "Specifies the text alignment of the component's value.", "docsTags": [], "default": "\"start\"", "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": false, "required": false }, { "name": "autofocus", "type": "boolean", "mutable": false, "attr": "autofocus", "reflectToAttr": true, "docs": "When `true`, the component is focused on page load.", "docsTags": [ { "name": "mdn", "text": "[autofocus](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "clearable", "type": "boolean", "mutable": false, "attr": "clearable", "reflectToAttr": true, "docs": "When `true`, a clear button is displayed when the component has a value.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [ { "name": "mdn", "text": "[disabled](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "groupSeparator", "type": "boolean", "mutable": false, "attr": "group-separator", "reflectToAttr": true, "docs": "When `true`, number values are displayed with a group separator corresponding to the language and country format.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "hidden", "type": "boolean", "mutable": false, "attr": "hidden", "reflectToAttr": true, "docs": "When `true`, the component will not be visible.", "docsTags": [ { "name": "mdn", "text": "[hidden](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/hidden)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "icon", "type": "boolean | string", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon.", "docsTags": [], "values": [ { "type": "boolean" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "iconFlipRtl", "type": "boolean", "mutable": false, "attr": "icon-flip-rtl", "reflectToAttr": true, "docs": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`).", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "intlClear", "type": "string", "mutable": false, "attr": "intl-clear", "reflectToAttr": false, "docs": "A text label that will appear on the clear button for screen readers.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlLoading", "type": "string", "mutable": false, "attr": "intl-loading", "reflectToAttr": false, "docs": "Accessible name that will appear while loading.", "docsTags": [ { "name": "default", "text": "\"Loading\"" } ], "default": "COMMON_TEXT.loading", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Accessible name for the component's button or hyperlink.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When `true`, the component is in the loading state and `calcite-progress` is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "locale", "type": "string", "mutable": false, "attr": "locale", "reflectToAttr": false, "docs": "Specifies the BCP 47 language tag for the desired language and country format.", "docsTags": [ { "name": "deprecated", "text": "set the global `lang` attribute on the element instead." }, { "name": "mdn", "text": "[lang](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang)" } ], "deprecation": "set the global `lang` attribute on the element instead.", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "max", "type": "number", "mutable": false, "attr": "max", "reflectToAttr": true, "docs": "Specifies the maximum value.", "docsTags": [ { "name": "mdn", "text": "[max](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max)" } ], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "maxLength", "type": "number", "mutable": false, "attr": "max-length", "reflectToAttr": true, "docs": "Specifies the maximum length of text for the component's value.", "docsTags": [ { "name": "mdn", "text": "[maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength)" } ], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "min", "type": "number", "mutable": false, "attr": "min", "reflectToAttr": true, "docs": "Specifies the minimum value.", "docsTags": [ { "name": "mdn", "text": "[min](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min)" } ], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "minLength", "type": "number", "mutable": false, "attr": "min-length", "reflectToAttr": true, "docs": "Specifies the minimum length of text for the component's value.", "docsTags": [ { "name": "mdn", "text": "[minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength)" } ], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component.", "docsTags": [ { "name": "mdn", "text": "[name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)" } ], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "numberButtonType", "type": "\"horizontal\" | \"none\" | \"vertical\"", "mutable": false, "attr": "number-button-type", "reflectToAttr": true, "docs": "Specifies the placement of the buttons.", "docsTags": [], "default": "\"vertical\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "none", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": true, "required": false }, { "name": "numberingSystem", "type": "\"arab\" | \"arabext\" | \"bali\" | \"beng\" | \"deva\" | \"fullwide\" | \"gujr\" | \"guru\" | \"hanidec\" | \"khmr\" | \"knda\" | \"laoo\" | \"latn\" | \"limb\" | \"mlym\" | \"mong\" | \"mymr\" | \"orya\" | \"tamldec\" | \"telu\" | \"thai\" | \"tibt\"", "mutable": false, "attr": "numbering-system", "reflectToAttr": true, "docs": "Specifies the Unicode numeral system used by the component for localization.", "docsTags": [], "values": [ { "value": "arab", "type": "string" }, { "value": "arabext", "type": "string" }, { "value": "bali", "type": "string" }, { "value": "beng", "type": "string" }, { "value": "deva", "type": "string" }, { "value": "fullwide", "type": "string" }, { "value": "gujr", "type": "string" }, { "value": "guru", "type": "string" }, { "value": "hanidec", "type": "string" }, { "value": "khmr", "type": "string" }, { "value": "knda", "type": "string" }, { "value": "laoo", "type": "string" }, { "value": "latn", "type": "string" }, { "value": "limb", "type": "string" }, { "value": "mlym", "type": "string" }, { "value": "mong", "type": "string" }, { "value": "mymr", "type": "string" }, { "value": "orya", "type": "string" }, { "value": "tamldec", "type": "string" }, { "value": "telu", "type": "string" }, { "value": "thai", "type": "string" }, { "value": "tibt", "type": "string" } ], "optional": true, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "Specifies placeholder text for the component.", "docsTags": [ { "name": "mdn", "text": "[placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder)" } ], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "prefixText", "type": "string", "mutable": false, "attr": "prefix-text", "reflectToAttr": false, "docs": "Adds text to the start of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "readOnly", "type": "boolean", "mutable": false, "attr": "read-only", "reflectToAttr": true, "docs": "When `true`, the component's value can be read, but cannot be modified.", "docsTags": [ { "name": "mdn", "text": "[readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": true, "docs": "When `true`, the component must have a value in order for the form to submit.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": true, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "status", "type": "\"idle\" | \"invalid\" | \"valid\"", "mutable": true, "attr": "status", "reflectToAttr": true, "docs": "Specifies the status of the input field, which determines message and icons.", "docsTags": [], "default": "\"idle\"", "values": [ { "value": "idle", "type": "string" }, { "value": "invalid", "type": "string" }, { "value": "valid", "type": "string" } ], "optional": false, "required": false }, { "name": "step", "type": "\"any\" | number", "mutable": false, "attr": "step", "reflectToAttr": true, "docs": "Specifies the granularity that the component's value must adhere to.", "docsTags": [ { "name": "mdn", "text": "[step](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step)" } ], "values": [ { "value": "any", "type": "string" }, { "type": "number" } ], "optional": true, "required": false }, { "name": "suffixText", "type": "string", "mutable": false, "attr": "suffix-text", "reflectToAttr": false, "docs": "Adds text to the end of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "value", "type": "string", "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The component's value.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "selectText", "returns": { "type": "Promise", "docs": "" }, "signature": "selectText() => Promise", "parameters": [], "docs": "Selects all text of the component's `value`.", "docsTags": [] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteInputNumberChange", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires each time a new value is typed and committed.", "docsTags": [] }, { "event": "calciteInputNumberInput", "detail": "any", "bubbles": true, "cancelable": true, "composed": true, "docs": "Fires each time a new value is typed.\n\n**Note:**: The `el` and `value` event payload props are deprecated, please use the event's `target`/`currentTarget` instead", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "action", "docs": "A slot for positioning a button next to the component." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-progress", "calcite-icon" ], "dependencyGraph": { "calcite-input-number": [ "calcite-progress", "calcite-icon" ] } }, { "filePath": "./src/components/input-text/input-text.tsx", "encapsulation": "shadow", "tag": "calcite-input-text", "readme": "# calcite-input-text\n", "docs": "", "docsTags": [ { "name": "slot", "text": "action - A slot for positioning a button next to the component." } ], "usage": {}, "props": [ { "name": "alignment", "type": "\"end\" | \"start\"", "mutable": false, "attr": "alignment", "reflectToAttr": true, "docs": "Specifies the text alignment of the component's value.", "docsTags": [], "default": "\"start\"", "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": false, "required": false }, { "name": "autofocus", "type": "boolean", "mutable": false, "attr": "autofocus", "reflectToAttr": true, "docs": "When `true`, the component is focused on page load.", "docsTags": [ { "name": "mdn", "text": "[autofocus](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "clearable", "type": "boolean", "mutable": false, "attr": "clearable", "reflectToAttr": true, "docs": "When `true`, a clear button is displayed when the component has a value.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [ { "name": "mdn", "text": "[disabled](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "hidden", "type": "boolean", "mutable": false, "attr": "hidden", "reflectToAttr": true, "docs": "When `true`, the component will not be visible.", "docsTags": [ { "name": "mdn", "text": "[hidden](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/hidden)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "icon", "type": "boolean | string", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon.", "docsTags": [], "values": [ { "type": "boolean" }, { "type": "string" } ], "optional": false, "required": false }, { "name": "iconFlipRtl", "type": "boolean", "mutable": false, "attr": "icon-flip-rtl", "reflectToAttr": true, "docs": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`).", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "intlClear", "type": "string", "mutable": false, "attr": "intl-clear", "reflectToAttr": false, "docs": "A text label that will appear on the clear button for screen readers.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlLoading", "type": "string", "mutable": false, "attr": "intl-loading", "reflectToAttr": false, "docs": "Accessible name that will appear while loading.", "docsTags": [ { "name": "default", "text": "\"Loading\"" } ], "default": "COMMON_TEXT.loading", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Accessible name for the component's button or hyperlink.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When `true`, the component is in the loading state and `calcite-progress` is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "maxLength", "type": "number", "mutable": false, "attr": "max-length", "reflectToAttr": true, "docs": "Specifies the maximum length of text for the component's value.", "docsTags": [ { "name": "mdn", "text": "[maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength)" } ], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "minLength", "type": "number", "mutable": false, "attr": "min-length", "reflectToAttr": true, "docs": "Specifies the minimum length of text for the component's value.", "docsTags": [ { "name": "mdn", "text": "[minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength)" } ], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component.", "docsTags": [ { "name": "mdn", "text": "[name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)" } ], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "placeholder", "type": "string", "mutable": false, "attr": "placeholder", "reflectToAttr": false, "docs": "Specifies placeholder text for the component.", "docsTags": [ { "name": "mdn", "text": "[placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder)" } ], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "prefixText", "type": "string", "mutable": false, "attr": "prefix-text", "reflectToAttr": false, "docs": "Adds text to the start of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "readOnly", "type": "boolean", "mutable": false, "attr": "read-only", "reflectToAttr": true, "docs": "When `true`, the component's value can be read, but cannot be modified.", "docsTags": [ { "name": "mdn", "text": "[readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": true, "docs": "When `true`, the component must have a value in order for the form to submit.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": true, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "status", "type": "\"idle\" | \"invalid\" | \"valid\"", "mutable": true, "attr": "status", "reflectToAttr": true, "docs": "Specifies the status of the input field, which determines message and icons.", "docsTags": [], "default": "\"idle\"", "values": [ { "value": "idle", "type": "string" }, { "value": "invalid", "type": "string" }, { "value": "valid", "type": "string" } ], "optional": false, "required": false }, { "name": "suffixText", "type": "string", "mutable": false, "attr": "suffix-text", "reflectToAttr": false, "docs": "Adds text to the end of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "value", "type": "string", "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The component's value.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "selectText", "returns": { "type": "Promise", "docs": "" }, "signature": "selectText() => Promise", "parameters": [], "docs": "Selects all text of the component's `value`.", "docsTags": [] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteInputTextChange", "detail": "void", "bubbles": true, "cancelable": true, "composed": true, "docs": "Fires each time a new value is typed and committed.", "docsTags": [] }, { "event": "calciteInputTextInput", "detail": "{ element: HTMLInputElement; nativeEvent: KeyboardEvent | MouseEvent | InputEvent; value: string; }", "bubbles": true, "cancelable": true, "composed": true, "docs": "Fires each time a new value is typed.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "action", "docs": "A slot for positioning a button next to the component." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-progress", "calcite-icon" ], "dependencyGraph": { "calcite-input-text": [ "calcite-progress", "calcite-icon" ] } }, { "filePath": "./src/components/input-time-picker/input-time-picker.tsx", "encapsulation": "shadow", "tag": "calcite-input-time-picker", "readme": "# calcite-input-time-picker\n", "docs": "", "docsTags": [], "usage": { "Basic": "```html\n\n```\n" }, "props": [ { "name": "active", "type": "boolean", "mutable": true, "attr": "active", "reflectToAttr": true, "docs": "When `true`, the component is active.", "docsTags": [ { "name": "deprecated", "text": "Use `open` instead." } ], "default": "false", "deprecation": "Use `open` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "intlHour", "type": "string", "mutable": false, "attr": "intl-hour", "reflectToAttr": false, "docs": "Accessible name for the component's hour input.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlHourDown", "type": "string", "mutable": false, "attr": "intl-hour-down", "reflectToAttr": false, "docs": "Accessible name for the component's hour down button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlHourUp", "type": "string", "mutable": false, "attr": "intl-hour-up", "reflectToAttr": false, "docs": "Accessible name for the component's hour up button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlMeridiem", "type": "string", "mutable": false, "attr": "intl-meridiem", "reflectToAttr": false, "docs": "Accessible name for the component's meridiem (am/pm) input.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlMeridiemDown", "type": "string", "mutable": false, "attr": "intl-meridiem-down", "reflectToAttr": false, "docs": "Accessible name for the component's meridiem (am/pm) down button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlMeridiemUp", "type": "string", "mutable": false, "attr": "intl-meridiem-up", "reflectToAttr": false, "docs": "Accessible name for the component's meridiem (am/pm) up button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlMinute", "type": "string", "mutable": false, "attr": "intl-minute", "reflectToAttr": false, "docs": "Accessible name for the component's minute input.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlMinuteDown", "type": "string", "mutable": false, "attr": "intl-minute-down", "reflectToAttr": false, "docs": "Accessible name for the component's minute down button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlMinuteUp", "type": "string", "mutable": false, "attr": "intl-minute-up", "reflectToAttr": false, "docs": "Accessible name for the component's minute up button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlSecond", "type": "string", "mutable": false, "attr": "intl-second", "reflectToAttr": false, "docs": "Accessible name for the component's second input.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlSecondDown", "type": "string", "mutable": false, "attr": "intl-second-down", "reflectToAttr": false, "docs": "Accessible name for the component's second down button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlSecondUp", "type": "string", "mutable": false, "attr": "intl-second-up", "reflectToAttr": false, "docs": "Accessible name for the component's second up button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": false, "docs": "Specifies the name of the component on form submission.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "numberingSystem", "type": "\"arab\" | \"arabext\" | \"bali\" | \"beng\" | \"deva\" | \"fullwide\" | \"gujr\" | \"guru\" | \"hanidec\" | \"khmr\" | \"knda\" | \"laoo\" | \"latn\" | \"limb\" | \"mlym\" | \"mong\" | \"mymr\" | \"orya\" | \"tamldec\" | \"telu\" | \"thai\" | \"tibt\"", "mutable": false, "attr": "numbering-system", "reflectToAttr": false, "docs": "Specifies the Unicode numeral system used by the component for localization.", "docsTags": [], "values": [ { "value": "arab", "type": "string" }, { "value": "arabext", "type": "string" }, { "value": "bali", "type": "string" }, { "value": "beng", "type": "string" }, { "value": "deva", "type": "string" }, { "value": "fullwide", "type": "string" }, { "value": "gujr", "type": "string" }, { "value": "guru", "type": "string" }, { "value": "hanidec", "type": "string" }, { "value": "khmr", "type": "string" }, { "value": "knda", "type": "string" }, { "value": "laoo", "type": "string" }, { "value": "latn", "type": "string" }, { "value": "limb", "type": "string" }, { "value": "mlym", "type": "string" }, { "value": "mong", "type": "string" }, { "value": "mymr", "type": "string" }, { "value": "orya", "type": "string" }, { "value": "tamldec", "type": "string" }, { "value": "telu", "type": "string" }, { "value": "thai", "type": "string" }, { "value": "tibt", "type": "string" } ], "optional": true, "required": false }, { "name": "open", "type": "boolean", "mutable": true, "attr": "open", "reflectToAttr": true, "docs": "When `true`, displays the `calcite-time-picker` component.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "overlayPositioning", "type": "\"absolute\" | \"fixed\"", "mutable": false, "attr": "overlay-positioning", "reflectToAttr": false, "docs": "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\"`.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "type": "string" } ], "optional": false, "required": false }, { "name": "placement", "type": "Placement | VariationPlacement | AutoPlacement | DeprecatedPlacement", "mutable": false, "attr": "placement", "reflectToAttr": true, "docs": "Determines where the popover will be positioned relative to the input.", "docsTags": [ { "name": "see", "text": "[LogicalPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/floating-ui.ts#L25)" } ], "default": "\"auto\"", "values": [ { "type": "Placement" }, { "type": "VariationPlacement" }, { "type": "AutoPlacement" }, { "type": "DeprecatedPlacement" } ], "optional": false, "required": false }, { "name": "readOnly", "type": "boolean", "mutable": false, "attr": "read-only", "reflectToAttr": true, "docs": "When `true`, the component's value can be read, but controls are not accessible and the value cannot be modified.", "docsTags": [ { "name": "mdn", "text": "[readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "step", "type": "number", "mutable": false, "attr": "step", "reflectToAttr": false, "docs": "Specifies the granularity the component's `value` must adhere to (in seconds).", "docsTags": [], "default": "60", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The component's value in UTC (always 24-hour format).", "docsTags": [], "default": "null", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "reposition", "returns": { "type": "Promise", "docs": "" }, "signature": "reposition(delayed?: boolean) => Promise", "parameters": [], "docs": "Updates the position of the component.", "docsTags": [ { "name": "param", "text": "delayed" } ] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteInputTimePickerChange", "detail": "string", "bubbles": true, "cancelable": true, "composed": true, "docs": "Fires when the time value is changed as a result of user input.", "docsTags": [] } ], "listeners": [ { "event": "click", "capture": false, "passive": false }, { "event": "calciteInternalTimePickerBlur", "capture": false, "passive": false }, { "event": "calciteInternalTimePickerFocus", "capture": false, "passive": false } ], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "calcite-input", "calcite-popover", "calcite-time-picker" ], "dependencyGraph": { "calcite-input-time-picker": [ "calcite-input", "calcite-popover", "calcite-time-picker" ], "calcite-input": [ "calcite-progress", "calcite-icon" ], "calcite-popover": [ "calcite-action", "calcite-icon" ], "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-time-picker": [ "calcite-icon" ] } }, { "filePath": "./src/components/label/label.tsx", "encapsulation": "shadow", "tag": "calcite-label", "readme": "# calcite-label\n\nRenders a `
\n
Header!
\n \n

Actions are in the top left and right.

\n\n```\n", "With-footer": "Renders a panel with a header and a footer.\n\n```html\n\n
Header!
\n

I have a footer.

\n
Footer!
\n
\n```\n" }, "props": [ { "name": "beforeBack", "type": "() => Promise", "mutable": false, "reflectToAttr": false, "docs": "When provided, this method will be called before it is removed from the parent flow.", "docsTags": [ { "name": "deprecated", "text": "use `calcite-flow-item` instead." } ], "deprecation": "use `calcite-flow-item` instead.", "values": [ { "type": "() => Promise" } ], "optional": true, "required": false }, { "name": "closable", "type": "boolean", "mutable": true, "attr": "closable", "reflectToAttr": true, "docs": "When `true`, displays a close button in the trailing side of the header.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "closed", "type": "boolean", "mutable": true, "attr": "closed", "reflectToAttr": true, "docs": "When `true`, the component will be hidden.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": false, "docs": "A description for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "dismissed", "type": "boolean", "mutable": true, "attr": "dismissed", "reflectToAttr": true, "docs": "When `true`, hides the component.", "docsTags": [ { "name": "deprecated", "text": "use `closed` instead." } ], "default": "false", "deprecation": "use `closed` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "dismissible", "type": "boolean", "mutable": true, "attr": "dismissible", "reflectToAttr": true, "docs": "When `true`, a close button is added to the component.", "docsTags": [ { "name": "deprecated", "text": "use `closable` instead" } ], "default": "false", "deprecation": "use `closable` instead", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "heading", "type": "string", "mutable": false, "attr": "heading", "reflectToAttr": false, "docs": "The component header text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "1 | 2 | 3 | 4 | 5 | 6", "mutable": false, "attr": "heading-level", "reflectToAttr": true, "docs": "Specifies the number at which section headings should start.", "docsTags": [], "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "optional": false, "required": false }, { "name": "heightScale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "height-scale", "reflectToAttr": true, "docs": "Specifies the maximum height of the component.", "docsTags": [], "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false }, { "name": "intlBack", "type": "string", "mutable": false, "attr": "intl-back", "reflectToAttr": false, "docs": "Accessible name for the component's back button. The back button will only be shown when `showBackButton` is `true`.", "docsTags": [ { "name": "deprecated", "text": "use `calcite-flow-item` instead." } ], "deprecation": "use `calcite-flow-item` instead.", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlClose", "type": "string", "mutable": false, "attr": "intl-close", "reflectToAttr": false, "docs": "Accessible name for the component's close button. The close button will only be shown when `closeable` is `true`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlOptions", "type": "string", "mutable": false, "attr": "intl-options", "reflectToAttr": false, "docs": "Accessible name for the component's actions menu.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When `true`, a busy indicator is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "menuOpen", "type": "boolean", "mutable": false, "attr": "menu-open", "reflectToAttr": true, "docs": "When `true`, the action menu items in the `header-menu-actions` slot are open.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "showBackButton", "type": "boolean", "mutable": false, "attr": "show-back-button", "reflectToAttr": true, "docs": "When `true`, displays a back button in the header.", "docsTags": [ { "name": "deprecated", "text": "use `calcite-flow-item` instead." } ], "default": "false", "deprecation": "use `calcite-flow-item` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "summary", "type": "string", "mutable": false, "attr": "summary", "reflectToAttr": false, "docs": "Summary text. A description displayed underneath the heading.", "docsTags": [ { "name": "deprecated", "text": "use `description` instead." } ], "deprecation": "use `description` instead.", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "widthScale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "width-scale", "reflectToAttr": true, "docs": "Specifies the width of the component.", "docsTags": [], "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false } ], "methods": [ { "name": "scrollContentTo", "returns": { "type": "Promise", "docs": "" }, "signature": "scrollContentTo(options?: ScrollToOptions) => Promise", "parameters": [], "docs": "Scrolls the component's content to a specified set of coordinates.", "docsTags": [ { "name": "example", "text": "myCalciteFlowItem.scrollContentTo({\n left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.\n top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element\n behavior: \"auto\" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).\n});" }, { "name": "param", "text": "options" } ] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus(focusId?: \"back-button\" | \"dismiss-button\") => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [ { "name": "param", "text": "focusId" } ] } ], "events": [ { "event": "calcitePanelBackClick", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the back button is clicked.", "docsTags": [ { "name": "deprecated", "text": "use `calcite-flow-item` instead." } ], "deprecation": "use `calcite-flow-item` instead." }, { "event": "calcitePanelClose", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the close button is clicked.", "docsTags": [] }, { "event": "calcitePanelDismiss", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the close button is clicked.", "docsTags": [ { "name": "deprecated", "text": "use `calcitePanelClose` instead." } ], "deprecation": "use `calcitePanelClose` instead." }, { "event": "calcitePanelDismissedChange", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when there is a change to the `dismissed` property value .", "docsTags": [ { "name": "deprecated", "text": "use `calcitePanelClose` instead." } ], "deprecation": "use `calcitePanelClose` instead." }, { "event": "calcitePanelScroll", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the content is scrolled.", "docsTags": [] } ], "listeners": [], "styles": [ { "name": "--calcite-panel-max-height", "annotation": "prop", "docs": "The maximum height of the component." }, { "name": "--calcite-panel-max-width", "annotation": "prop", "docs": "The maximum width of the component." }, { "name": "--calcite-panel-min-width", "annotation": "prop", "docs": "The minimum width of the component." } ], "slots": [ { "name": "", "docs": "A slot for adding custom content." }, { "name": "fab", "docs": "A slot for adding a `calcite-fab` (floating action button) to perform an action." }, { "name": "footer", "docs": "A slot for adding custom content to the footer." }, { "name": "footer-actions", "docs": "A slot for adding buttons to the footer." }, { "name": "header-actions-end", "docs": "A slot for adding actions or content to the end side of the header." }, { "name": "header-actions-start", "docs": "A slot for adding actions or content to the start side of the header." }, { "name": "header-content", "docs": "A slot for adding custom content to the header." }, { "name": "header-menu-actions", "docs": "A slot for adding an overflow menu with actions inside a `calcite-dropdown`." } ], "parts": [], "dependents": [ "calcite-flow-item" ], "dependencies": [ "calcite-action", "calcite-action-menu", "calcite-scrim" ], "dependencyGraph": { "calcite-panel": [ "calcite-action", "calcite-action-menu", "calcite-scrim" ], "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-action-menu": [ "calcite-action", "calcite-popover" ], "calcite-popover": [ "calcite-action", "calcite-icon" ], "calcite-scrim": [ "calcite-loader" ], "calcite-flow-item": [ "calcite-panel" ] } }, { "filePath": "./src/components/pick-list/pick-list.tsx", "encapsulation": "shadow", "tag": "calcite-pick-list", "readme": "# calcite-pick-list\n\n`calcite-pick-list` lives in a panel and contains `calcite-pick-list-item`s. Each item is able to be be selected via radio button or checkboxes (which have a multiselect and shift-click capability). There is also an option for a filter at the top of the list for searching.\n", "docs": "`calcite-pick-list` lives in a panel and contains `calcite-pick-list-item`s. Each item is able to be be selected via radio button or checkboxes (which have a multiselect and shift-click capability). There is also an option for a filter at the top of the list for searching.", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-pick-list-item` or `calcite-pick-list-group` elements. Items are displayed as a vertical list." }, { "name": "slot", "text": "menu-actions - A slot for adding a button and menu combination for performing actions, such as sorting." } ], "usage": { "Basic": "Renders a basic pick list with radio buttons on the left and actions on the right side.\n\n```html\n\n \n \n \n \n \n \n \n \n \n\n```\n", "Multi-select-and-filter-enabled": "Renders a pick list with a sticky filter and checkboxes for multiple selection of items.\n\n```html\n\n \n \n \n \n \n \n \n \n \n\n```\n", "Sub-groups": "Renders groups of pick list items that are visually separated.\n\n```html\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n```\n" }, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "filterEnabled", "type": "boolean", "mutable": false, "attr": "filter-enabled", "reflectToAttr": true, "docs": "When `true`, an input appears at the top of the list that can be used by end users to filter items in the list.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "filterPlaceholder", "type": "string", "mutable": false, "attr": "filter-placeholder", "reflectToAttr": true, "docs": "Placeholder text for the filter input field.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "headingLevel", "type": "1 | 2 | 3 | 4 | 5 | 6", "mutable": false, "attr": "heading-level", "reflectToAttr": true, "docs": "Specifies the number at which section headings should start.", "docsTags": [], "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "optional": false, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When `true`, a busy indicator is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "multiple", "type": "boolean", "mutable": false, "attr": "multiple", "reflectToAttr": true, "docs": "Similar to standard radio buttons and checkboxes.\nWhen `true`, a user can select multiple `calcite-pick-list-item`s at a time.\nWhen `false`, only a single `calcite-pick-list-item` can be selected at a time,\nand a new selection will deselect previous selections.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "selectionFollowsFocus", "type": "boolean", "mutable": false, "attr": "selection-follows-focus", "reflectToAttr": true, "docs": "When `true` and single selection is enabled, the selection changes when navigating `calcite-pick-list-item`s via keyboard.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [ { "name": "getSelectedItems", "returns": { "type": "Promise>", "docs": "" }, "signature": "getSelectedItems() => Promise>", "parameters": [], "docs": "Returns the component's selected `calcite-pick-list-item`s.", "docsTags": [] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus(focusId?: ListFocusId) => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [ { "name": "param", "text": "focusId" } ] } ], "events": [ { "event": "calciteListChange", "detail": "Map", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when any of the `calcite-pick-list-item` selections have changed.", "docsTags": [] } ], "listeners": [ { "event": "calciteListItemRemove", "capture": false, "passive": false }, { "event": "calciteListItemChange", "capture": false, "passive": false }, { "event": "calciteInternalListItemPropsChange", "capture": false, "passive": false }, { "event": "calciteInternalListItemValueChange", "capture": false, "passive": false }, { "event": "focusout", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-pick-list-item` or `calcite-pick-list-group` elements. Items are displayed as a vertical list." }, { "name": "menu-actions", "docs": "A slot for adding a button and menu combination for performing actions, such as sorting." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-filter", "calcite-scrim" ], "dependencyGraph": { "calcite-pick-list": [ "calcite-filter", "calcite-scrim" ], "calcite-filter": [ "calcite-input" ], "calcite-input": [ "calcite-progress", "calcite-icon" ], "calcite-scrim": [ "calcite-loader" ] } }, { "filePath": "./src/components/pick-list-group/pick-list-group.tsx", "encapsulation": "shadow", "tag": "calcite-pick-list-group", "readme": "# calcite-pick-list-group\n\n`calcite-pick-list-group` is a wrapper for multiple `calcite-pick-list-item`s and lives in `calcite-pick-list`.\n", "docs": "`calcite-pick-list-group` is a wrapper for multiple `calcite-pick-list-item`s and lives in `calcite-pick-list`.", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-pick-list-item` elements." } ], "usage": {}, "props": [ { "name": "groupTitle", "type": "string", "mutable": false, "attr": "group-title", "reflectToAttr": true, "docs": "Specifies the title for all nested `calcite-pick-list-item`s.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "headingLevel", "type": "1 | 2 | 3 | 4 | 5 | 6", "mutable": false, "attr": "heading-level", "reflectToAttr": true, "docs": "Specifies the number at which section headings should start.", "docsTags": [], "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-pick-list-item` elements." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/pick-list-item/pick-list-item.tsx", "encapsulation": "shadow", "tag": "calcite-pick-list-item", "readme": "# calcite-pick-list-item\n\n`calcite-pick-list-item`s are cards contained in a `calcite-pick-list`. They each can have a label and description, an icon, and be set to compact. The developer can disable or preselect each list item and give it a value.\n", "docs": "`calcite-pick-list-item`s are cards contained in a `calcite-pick-list`. They each can have a label and description, an icon, and be set to compact. The developer can disable or preselect each list item and give it a value.", "docsTags": [ { "name": "slot", "text": "actions-end - A slot for adding `calcite-action`s or content to the end side of the component." }, { "name": "slot", "text": "actions-start - A slot for adding `calcite-action`s or content to the start side of the component." } ], "usage": {}, "props": [ { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": true, "docs": "A description for the component that displays below the label text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "disableDeselect", "type": "boolean", "mutable": false, "attr": "disable-deselect", "reflectToAttr": true, "docs": "When `false`, the component cannot be deselected by user interaction.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "icon", "type": "ICON_TYPES.circle | ICON_TYPES.grip | ICON_TYPES.square", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "Determines the icon SVG symbol that will be shown. Options are `\"circle\"`, `\"square\"`, `\"grip\"` or `null`.", "docsTags": [ { "name": "see", "text": "[ICON_TYPES](https://github.com/Esri/calcite-components/blob/master/src/components/pick-list/resources.ts#L5)" } ], "default": "null", "values": [ { "type": "ICON_TYPES.circle" }, { "type": "ICON_TYPES.grip" }, { "type": "ICON_TYPES.square" } ], "optional": true, "required": false }, { "name": "intlRemove", "type": "string", "mutable": false, "attr": "intl-remove", "reflectToAttr": true, "docs": "When `removable` is `true`, the accessible name for the component's remove button.", "docsTags": [ { "name": "default", "text": "\"Remove\"" } ], "default": "TEXT.remove", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": true, "docs": "Label and accessible name for the component. Appears next to the icon.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "metadata", "type": "{ [x: string]: unknown; }", "mutable": false, "reflectToAttr": false, "docs": "Provides additional metadata to the component. Primary use is for a filter on the parent list.", "docsTags": [], "values": [ { "type": "{ [x: string]: unknown; }" } ], "optional": true, "required": false }, { "name": "removable", "type": "boolean", "mutable": false, "attr": "removable", "reflectToAttr": true, "docs": "When `true`, displays a remove action that removes the item from the list.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "selected", "type": "boolean", "mutable": true, "attr": "selected", "reflectToAttr": true, "docs": "When `true`, selects an item. Toggles when an item is checked/unchecked.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "any", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The component's value.", "docsTags": [], "values": [ { "type": "any" } ], "optional": false, "required": true } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] }, { "name": "toggleSelected", "returns": { "type": "Promise", "docs": "" }, "signature": "toggleSelected(coerce?: boolean) => Promise", "parameters": [], "docs": "Toggles the selection state. By default this won't trigger an event.\nThe first argument allows the value to be coerced, rather than swapping values.", "docsTags": [ { "name": "param", "text": "coerce" } ] } ], "events": [ { "event": "calciteListItemChange", "detail": "{ item: HTMLCalcitePickListItemElement; value: any; selected: boolean; shiftPressed: boolean; }", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is selected or unselected.", "docsTags": [] }, { "event": "calciteListItemRemove", "detail": "void", "bubbles": true, "cancelable": true, "composed": true, "docs": "Fires when the remove button is pressed.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "actions-end", "docs": "A slot for adding `calcite-action`s or content to the end side of the component." }, { "name": "actions-start", "docs": "A slot for adding `calcite-action`s or content to the start side of the component." } ], "parts": [], "dependents": [ "calcite-value-list-item" ], "dependencies": [ "calcite-icon", "calcite-action" ], "dependencyGraph": { "calcite-pick-list-item": [ "calcite-icon", "calcite-action" ], "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-value-list-item": [ "calcite-pick-list-item" ] } }, { "filePath": "./src/components/popover/popover.tsx", "encapsulation": "shadow", "tag": "calcite-popover", "readme": "# calcite-popover\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding custom content." } ], "usage": { "Basic": "```html\nHello! I am some popover content!\n\nClickable popover\n```\n", "Virtual": "```html\n\n\n

Hello! I am some virtual popover content!

\n
\n\n\n```\n" }, "props": [ { "name": "autoClose", "type": "boolean", "mutable": false, "attr": "auto-close", "reflectToAttr": true, "docs": "When `true`, clicking outside of the component automatically closes open `calcite-popover`s.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "closable", "type": "boolean", "mutable": true, "attr": "closable", "reflectToAttr": true, "docs": "When `true`, display a close button within the component.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "closeButton", "type": "boolean", "mutable": false, "attr": "close-button", "reflectToAttr": true, "docs": "When `true`, a close button is added to the component.", "docsTags": [ { "name": "deprecated", "text": "use dismissible instead." } ], "default": "false", "deprecation": "use dismissible instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disableFlip", "type": "boolean", "mutable": false, "attr": "disable-flip", "reflectToAttr": true, "docs": "When `true`, prevents flipping the component's placement when overlapping its `referenceElement`.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disablePointer", "type": "boolean", "mutable": false, "attr": "disable-pointer", "reflectToAttr": true, "docs": "When `true`, removes the caret pointer.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "dismissible", "type": "boolean", "mutable": true, "attr": "dismissible", "reflectToAttr": true, "docs": "When `true`, a close button is added to the component.", "docsTags": [ { "name": "deprecated", "text": "use `closable` instead." } ], "default": "false", "deprecation": "use `closable` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "flipPlacements", "type": "Placement[]", "mutable": false, "reflectToAttr": false, "docs": "Defines the available placements that can be used when a flip occurs.", "docsTags": [], "values": [ { "type": "Placement[]" } ], "optional": true, "required": false }, { "name": "heading", "type": "string", "mutable": false, "attr": "heading", "reflectToAttr": false, "docs": "The component header text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "1 | 2 | 3 | 4 | 5 | 6", "mutable": false, "attr": "heading-level", "reflectToAttr": true, "docs": "Specifies the number at which section headings should start.", "docsTags": [], "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "optional": false, "required": false }, { "name": "intlClose", "type": "string", "mutable": false, "attr": "intl-close", "reflectToAttr": false, "docs": "Accessible name for the component's close button.", "docsTags": [ { "name": "default", "text": "\"Close\"" } ], "default": "TEXT.close", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Accessible name for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "offsetDistance", "type": "number", "mutable": false, "attr": "offset-distance", "reflectToAttr": true, "docs": "Offsets the position of the component away from the `referenceElement`.", "docsTags": [ { "name": "default", "text": "6" } ], "default": "defaultOffsetDistance", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "offsetSkidding", "type": "number", "mutable": false, "attr": "offset-skidding", "reflectToAttr": true, "docs": "Offsets the position of the component along the `referenceElement`.", "docsTags": [], "default": "0", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "open", "type": "boolean", "mutable": true, "attr": "open", "reflectToAttr": true, "docs": "When `true`, displays and positions the component.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "overlayPositioning", "type": "\"absolute\" | \"fixed\"", "mutable": false, "attr": "overlay-positioning", "reflectToAttr": true, "docs": "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\"` value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `\"fixed\"`.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "type": "string" } ], "optional": false, "required": false }, { "name": "placement", "type": "Placement | VariationPlacement | AutoPlacement | DeprecatedPlacement", "mutable": false, "attr": "placement", "reflectToAttr": true, "docs": "Determines where the component will be positioned relative to the `referenceElement`.", "docsTags": [ { "name": "see", "text": "[LogicalPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/floating-ui.ts#L25)" } ], "default": "defaultPopoverPlacement", "values": [ { "type": "Placement" }, { "type": "VariationPlacement" }, { "type": "AutoPlacement" }, { "type": "DeprecatedPlacement" } ], "optional": false, "required": false }, { "name": "referenceElement", "type": "Element | VirtualElement | string", "mutable": false, "attr": "reference-element", "reflectToAttr": false, "docs": "The `referenceElement` used to position the component according to its `placement` value. Setting to an `HTMLElement` is preferred so the component does not need to query the DOM. However, a string `id` of the reference element can also be used.", "docsTags": [], "values": [ { "type": "Element" }, { "type": "VirtualElement" }, { "type": "string" } ], "optional": false, "required": true }, { "name": "triggerDisabled", "type": "boolean", "mutable": false, "attr": "trigger-disabled", "reflectToAttr": true, "docs": "When `true`, disables automatically toggling the component when its `referenceElement` has been triggered.\n\nThis property can be set to `true` to manage when the component is open.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [ { "name": "reposition", "returns": { "type": "Promise", "docs": "" }, "signature": "reposition(delayed?: boolean) => Promise", "parameters": [], "docs": "Updates the position of the component.", "docsTags": [ { "name": "param", "text": "delayed" } ] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus(focusId?: \"close-button\") => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [ { "name": "param", "text": "focusId" } ] }, { "name": "toggle", "returns": { "type": "Promise", "docs": "" }, "signature": "toggle(value?: boolean) => Promise", "parameters": [], "docs": "Toggles the component's open property.", "docsTags": [ { "name": "param", "text": "value" } ] } ], "events": [ { "event": "calcitePopoverBeforeClose", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is requested to be closed and before the closing transition begins.", "docsTags": [] }, { "event": "calcitePopoverBeforeOpen", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is added to the DOM but not rendered, and before the opening transition begins.", "docsTags": [] }, { "event": "calcitePopoverClose", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is closed and animation is complete.", "docsTags": [] }, { "event": "calcitePopoverOpen", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component is open and animation is complete.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding custom content." } ], "parts": [], "dependents": [ "calcite-action-menu", "calcite-input-time-picker" ], "dependencies": [ "calcite-action", "calcite-icon" ], "dependencyGraph": { "calcite-popover": [ "calcite-action", "calcite-icon" ], "calcite-action": [ "calcite-loader", "calcite-icon" ], "calcite-action-menu": [ "calcite-popover" ], "calcite-input-time-picker": [ "calcite-popover" ] } }, { "filePath": "./src/components/popover-manager/popover-manager.tsx", "encapsulation": "shadow", "tag": "calcite-popover-manager", "readme": "# calcite-popover-manager\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding elements that reference a 'calcite-popover' by the 'selector' property." }, { "name": "deprecated", "text": "No longer required for popover usage." } ], "usage": {}, "props": [ { "name": "autoClose", "type": "boolean", "mutable": false, "attr": "auto-close", "reflectToAttr": true, "docs": "Automatically closes any currently open popovers when clicking outside of a popover.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "selector", "type": "string", "mutable": false, "attr": "selector", "reflectToAttr": true, "docs": "CSS Selector to match reference elements for popovers. Reference elements will be identified by this selector in order to open their associated popover.", "docsTags": [ { "name": "default", "text": "`[data-calcite-popover-reference]`" } ], "default": "\"[data-calcite-popover-reference]\"", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding elements that reference a 'calcite-popover' by the 'selector' property." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {}, "deprecation": "No longer required for popover usage." }, { "filePath": "./src/components/progress/progress.tsx", "encapsulation": "shadow", "tag": "calcite-progress", "readme": "# calcite-progress\n\nThe `calcite-progress` component is used to show progress on some async task to the user.\n", "docs": "The `calcite-progress` component is used to show progress on some async task to the user.", "docsTags": [], "usage": { "Basic": "```html\n\n```\n" }, "props": [ { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Accessible name for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "reversed", "type": "boolean", "mutable": false, "attr": "reversed", "reflectToAttr": true, "docs": "When `true` and for `\"indeterminate\"` progress bars, reverses the animation direction.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "text", "type": "string", "mutable": false, "attr": "text", "reflectToAttr": false, "docs": "Text that displays under the component's indicator.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "type", "type": "\"determinate\" | \"indeterminate\"", "mutable": false, "attr": "type", "reflectToAttr": true, "docs": "Specifies the component type.\n\nUse `\"indeterminate\"` if finding actual progress value is impossible.", "docsTags": [], "default": "\"determinate\"", "values": [ { "value": "determinate", "type": "string" }, { "value": "indeterminate", "type": "string" } ], "optional": false, "required": false }, { "name": "value", "type": "number", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The component's progress value, with a range of 0.0 - 1.0.", "docsTags": [], "default": "0", "values": [ { "type": "number" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "calcite-input", "calcite-input-number", "calcite-input-text" ], "dependencies": [], "dependencyGraph": { "calcite-input": [ "calcite-progress" ], "calcite-input-number": [ "calcite-progress" ], "calcite-input-text": [ "calcite-progress" ] } }, { "filePath": "./src/components/radio-button/radio-button.tsx", "encapsulation": "shadow", "tag": "calcite-radio-button", "readme": "# calcite-radio-button\n", "docs": "", "docsTags": [], "usage": { "Basic": "```html\n\n \n Maps\n\n```\n" }, "props": [ { "name": "checked", "type": "boolean", "mutable": true, "attr": "checked", "reflectToAttr": true, "docs": "When `true`, the component is checked.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "guid", "type": "string", "mutable": true, "attr": "guid", "reflectToAttr": true, "docs": "The `id` of the component. When omitted, a globally unique identifier is used.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "hidden", "type": "boolean", "mutable": false, "attr": "hidden", "reflectToAttr": true, "docs": "When `true`, the component is not displayed and is not focusable or checkable.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component, passed from the `calcite-radio-button-group` on form submission.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": true, "docs": "When `true`, the component must have a value selected from the `calcite-radio-button-group` in order for the form to submit.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component inherited from the `calcite-radio-button-group`.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "value", "type": "any", "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The component's value.", "docsTags": [], "values": [ { "type": "any" } ], "optional": false, "required": true } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteRadioButtonChange", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires only when the radio button is checked. This behavior is identical to the native HTML input element.\nSince this event does not fire when the radio button is unchecked, it's not recommended to attach a listener for this event\ndirectly on the element, but instead either attach it to a node that contains all of the radio buttons in the group\nor use the `calciteRadioButtonGroupChange` event if using this with `calcite-radio-button-group`.", "docsTags": [] } ], "listeners": [ { "event": "pointerenter", "capture": false, "passive": true }, { "event": "pointerleave", "capture": false, "passive": true } ], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/radio-button-group/radio-button-group.tsx", "encapsulation": "shadow", "tag": "calcite-radio-button-group", "readme": "# calcite-radio-button-group\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-radio-button`s." } ], "usage": { "Basic": "Renders the radio button group with default horizontal layout\n\n```html\n\n \n \n Maps\n \n \n \n Layers\n \n \n \n Data\n \n \n \n Geography\n \n\n```\n", "Disabled-checked": "Renders all radio button inputs disabled, first one checked\n\n```html\n\n \n \n A\n \n \n \n B\n \n \n \n C\n \n\n```\n", "With-vertical-layout": "```html\n\n \n \n Maps\n \n \n \n Layers\n \n \n \n Data\n \n \n \n Geography\n \n\n```\n" }, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "hidden", "type": "boolean", "mutable": false, "attr": "hidden", "reflectToAttr": true, "docs": "When `true`, the component is not displayed and its `calcite-radio-button`s are not focusable or checkable.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "layout", "type": "\"grid\" | \"horizontal\" | \"vertical\"", "mutable": false, "attr": "layout", "reflectToAttr": true, "docs": "Defines the layout of the component.", "docsTags": [], "default": "\"horizontal\"", "values": [ { "value": "grid", "type": "string" }, { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": false, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component on form submission. Must be unique to other component instances.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": true, "docs": "When `true`, the component must have a value in order for the form to submit.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "calciteRadioButtonGroupChange", "detail": "any", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component has changed.", "docsTags": [] } ], "listeners": [ { "event": "calciteRadioButtonChange", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-radio-button`s." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/radio-group/radio-group.tsx", "encapsulation": "shadow", "tag": "calcite-radio-group", "readme": "# calcite-radio-group\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-radio-group-item`s." } ], "usage": { "Basic": "```html\n\n Apple\n Mango\n Tomato\n Banana\n\n```\n" }, "props": [ { "name": "appearance", "type": "\"outline\" | \"solid\"", "mutable": false, "attr": "appearance", "reflectToAttr": true, "docs": "Specifies the appearance style of the component.", "docsTags": [], "default": "\"solid\"", "values": [ { "value": "outline", "type": "string" }, { "value": "solid", "type": "string" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "layout", "type": "\"grid\" | \"horizontal\" | \"vertical\"", "mutable": false, "attr": "layout", "reflectToAttr": true, "docs": "Defines the layout of the component.", "docsTags": [], "default": "\"horizontal\"", "values": [ { "value": "grid", "type": "string" }, { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": false, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component on form submission.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "selectedItem", "type": "HTMLCalciteRadioGroupItemElement", "mutable": true, "reflectToAttr": false, "docs": "The component's selected item `HTMLElement`.", "docsTags": [ { "name": "readonly" } ], "values": [ { "type": "HTMLCalciteRadioGroupItemElement" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The component's `selectedItem` value.", "docsTags": [], "default": "null", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "width", "type": "\"auto\" | \"full\"", "mutable": false, "attr": "width", "reflectToAttr": true, "docs": "Specifies the width of the component.", "docsTags": [], "default": "\"auto\"", "values": [ { "value": "auto", "type": "string" }, { "value": "full", "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteRadioGroupChange", "detail": "string", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the selected option changes, where the event detail is the new value.", "docsTags": [] } ], "listeners": [ { "event": "calciteInternalRadioGroupItemChange", "capture": false, "passive": false }, { "event": "keydown", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-radio-group-item`s." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/radio-group-item/radio-group-item.tsx", "encapsulation": "shadow", "tag": "calcite-radio-group-item", "readme": "# calcite-radio-group-item\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "checked", "type": "boolean", "mutable": true, "attr": "checked", "reflectToAttr": true, "docs": "When `true`, the component is checked.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "icon", "type": "string", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "Specifies an icon to display.", "docsTags": [ { "name": "deprecated", "text": "Use either `iconStart` or `iconEnd` but do not combine them with `icon` and `iconPosition`." } ], "deprecation": "Use either `iconStart` or `iconEnd` but do not combine them with `icon` and `iconPosition`.", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "iconEnd", "type": "string", "mutable": false, "attr": "icon-end", "reflectToAttr": true, "docs": "Specifies an icon to display at the end of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "iconFlipRtl", "type": "boolean", "mutable": false, "attr": "icon-flip-rtl", "reflectToAttr": true, "docs": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`).", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "iconPosition", "type": "\"end\" | \"start\"", "mutable": false, "attr": "icon-position", "reflectToAttr": true, "docs": "Specifies the placement of the icon.", "docsTags": [ { "name": "deprecated", "text": "Use either `iconStart` or `iconEnd` but do not combine them with `icon` and `iconPosition`." } ], "default": "\"start\"", "deprecation": "Use either `iconStart` or `iconEnd` but do not combine them with `icon` and `iconPosition`.", "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": true, "required": false }, { "name": "iconStart", "type": "string", "mutable": false, "attr": "icon-start", "reflectToAttr": true, "docs": "Specifies an icon to display at the start of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "value", "type": "any", "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The component's value.", "docsTags": [], "values": [ { "type": "any" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "calcite-icon" ], "dependencyGraph": { "calcite-radio-group-item": [ "calcite-icon" ] } }, { "filePath": "./src/components/rating/rating.tsx", "encapsulation": "shadow", "tag": "calcite-rating", "readme": "# calcite-rating\n", "docs": "", "docsTags": [], "usage": { "Basic": "```html\n\n```\n" }, "props": [ { "name": "average", "type": "number", "mutable": false, "attr": "average", "reflectToAttr": true, "docs": "Specifies a cumulative average from previous ratings to display.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "count", "type": "number", "mutable": false, "attr": "count", "reflectToAttr": true, "docs": "Specifies the number of previous ratings to display.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "intlRating", "type": "string", "mutable": false, "attr": "intl-rating", "reflectToAttr": false, "docs": "Accessible name for the component.", "docsTags": [ { "name": "default", "text": "\"Rating\"" } ], "default": "TEXT.rating", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlStars", "type": "string", "mutable": false, "attr": "intl-stars", "reflectToAttr": false, "docs": "Accessible name for each star. The `${num}` in the string will be replaced by the number.", "docsTags": [ { "name": "default", "text": "\"Stars: ${num}\"" } ], "default": "TEXT.stars", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component on form submission.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "readOnly", "type": "boolean", "mutable": false, "attr": "read-only", "reflectToAttr": true, "docs": "When `true`, the component's value can be read, but cannot be modified.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "showChip", "type": "boolean", "mutable": false, "attr": "show-chip", "reflectToAttr": true, "docs": "When `true`, and if available, displays the `average` and/or `count` data summary in a `calcite-chip`.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "number", "mutable": true, "attr": "value", "reflectToAttr": true, "docs": "The component's value.", "docsTags": [], "default": "0", "values": [ { "type": "number" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteRatingChange", "detail": "{ value: number; }", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the component's value changes.", "docsTags": [] } ], "listeners": [ { "event": "blur", "capture": false, "passive": false } ], "styles": [ { "name": "--calcite-rating-spacing-unit", "annotation": "prop", "docs": "The amount of left and right margin spacing between each rating star." } ], "slots": [], "parts": [], "dependents": [], "dependencies": [ "calcite-icon", "calcite-chip" ], "dependencyGraph": { "calcite-rating": [ "calcite-icon", "calcite-chip" ], "calcite-chip": [ "calcite-icon" ] } }, { "filePath": "./src/components/scrim/scrim.tsx", "encapsulation": "shadow", "tag": "calcite-scrim", "readme": "# calcite-scrim\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding custom content, primarily loading information." } ], "usage": { "Basic": "```html\n
\n \n

I'm a panel that is not loading.

\n

This content can have any zIndex and it will not be placed above

\n

.

\n

.

\n

.

\n

.

\n
\n
\n```\n", "Loading-scrim-panel": "```html\n
\n \n

I'm a panel that is not loading.

\n

I have a loading spinner over my content.

\n

.

\n

.

\n

.

\n

.

\n
\n
\n```\n" }, "props": [ { "name": "intlLoading", "type": "string", "mutable": false, "attr": "intl-loading", "reflectToAttr": false, "docs": "Accessible name when the component is loading.", "docsTags": [ { "name": "default", "text": "\"Loading\"" } ], "default": "TEXT.loading", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When `true`, a busy indicator is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding custom content, primarily loading information." } ], "parts": [], "dependents": [ "calcite-block", "calcite-modal", "calcite-panel", "calcite-pick-list", "calcite-value-list" ], "dependencies": [ "calcite-loader" ], "dependencyGraph": { "calcite-scrim": [ "calcite-loader" ], "calcite-block": [ "calcite-scrim" ], "calcite-modal": [ "calcite-scrim" ], "calcite-panel": [ "calcite-scrim" ], "calcite-pick-list": [ "calcite-scrim" ], "calcite-value-list": [ "calcite-scrim" ] } }, { "filePath": "./src/components/select/select.tsx", "encapsulation": "shadow", "tag": "calcite-select", "readme": "# calcite-select\n\nThis component represents a menu of options.\n", "docs": "This component represents a menu of options.", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-option`s." } ], "usage": { "Basic": "```html\n\n high\n medium\n low\n\n```\n", "Content": "Specify the underlying value and content for each option.\n\n```html\n\n 1\n 2\n 3\n\n```\n", "Disable": "Disable specific items or groups.\n\n```html\n\n \n a\n b\n c\n d (disabled)\n \n \n 1 (disabled)\n 2\n 2\n \n \n You-Know-Who\n Tom Marvolo Riddle\n He-Who-Must-Not-Be-Named\n Voldemort\n \n\n```\n", "Grouped": "Separate the options into groups.\n\n```html\n\n \n a\n b\n c\n \n \n 1\n 2\n 3\n \n\n```\n", "Side-by-side": "Separate the options side by side using a flex-box container.\n\n```html\n
\n \n ☕️\n 🍵\n 🍻\n \n \n 🌮\n 🍔\n 🌯\n \n
\n```\n", "Value": "Specify the underlying value for each option.\n\n```html\n\n 😃\n 😶\n 😭\n\n```\n" }, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Accessible name for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component on form submission.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "selectedOption", "type": "HTMLCalciteOptionElement", "mutable": true, "reflectToAttr": false, "docs": "The component's selected option `HTMLElement`.", "docsTags": [ { "name": "readonly" } ], "values": [ { "type": "HTMLCalciteOptionElement" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The component's `selectedOption` value.", "docsTags": [], "default": "null", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "width", "type": "\"auto\" | \"full\" | \"half\"", "mutable": false, "attr": "width", "reflectToAttr": true, "docs": "Specifies the width of the component.", "docsTags": [], "default": "\"auto\"", "values": [ { "value": "auto", "type": "string" }, { "value": "full", "type": "string" }, { "value": "half", "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteSelectChange", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the `selectedOption` changes.", "docsTags": [] } ], "listeners": [ { "event": "calciteInternalOptionChange", "capture": false, "passive": false }, { "event": "calciteInternalOptionGroupChange", "capture": false, "passive": false } ], "styles": [ { "name": "--calcite-select-font-size", "annotation": "prop", "docs": "The font size of items in the component." }, { "name": "--calcite-select-spacing", "annotation": "prop", "docs": "The padding around the selected option text." } ], "slots": [ { "name": "", "docs": "A slot for adding `calcite-option`s." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-icon" ], "dependencyGraph": { "calcite-select": [ "calcite-icon" ] } }, { "filePath": "./src/components/shell/shell.tsx", "encapsulation": "shadow", "tag": "calcite-shell", "readme": "# calcite-shell\n\nThe `calcite-shell` component is used for application layout management. It is a container for the view as well as other calcite components like `calcite-shell-panel` and `calcite-tip-manager`.\n\n_note: calcite-shell supports tablet as the smallest screen size_\n", "docs": "The `calcite-shell` component is used for application layout management. It is a container for the view as well as other calcite components like `calcite-shell-panel` and `calcite-tip-manager`.\n\n_note: calcite-shell supports tablet as the smallest screen size_", "docsTags": [ { "name": "slot", "text": "- A slot for adding content to the component. This content will appear between any leading and trailing panels added to the component, such as a map." }, { "name": "slot", "text": "header - A slot for adding header content. This content will be positioned at the top of the component." }, { "name": "slot", "text": "footer - A slot for adding footer content. This content will be positioned at the bottom of the component." }, { "name": "slot", "text": "panel-start - A slot for adding the starting `calcite-shell-panel`." }, { "name": "slot", "text": "panel-end - A slot for adding the ending `calcite-shell-panel`." }, { "name": "slot", "text": "primary-panel - [DEPRECATED] A slot for adding the leading `calcite-shell-panel`." }, { "name": "slot", "text": "contextual-panel - [DEPRECATED] A slot for adding the trailing `calcite-shell-panel`." }, { "name": "slot", "text": "center-row - A slot for adding content to the center row." } ], "usage": { "Advanced": "Renders a shell with leading and trailing floating panels, action bar/pad, block, flow, tip manager, footer.\n\n```html\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Cool thing.

\n
\n
\n
\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Footer
\n
\n```\n", "Basic": "Renders a basic shell with a header and a footer.\n\n```html\n\n
\n
\n

Shell Header: My App

\n
\n
\n

Shell Content

\n \n
Footer
\n
\n```\n", "With-panel-and-action-bar": "Renders a single panel with actions in an action bar.\n\n```html\n\n \n \"placeholder\"\n \n \n \n \n \n \n\n```\n", "With-panels": "Renders a shell with a header and panels on the left and right sides of the app.\n\n```html\n\n \n Leading panel! (on the left side, since this is a LTR app)\n \n Trailing panel! (right side) \n \n Center Row! (center bottom)\n \n
\n
\n

Shell Header: My App

\n
\n
\n

Shell Content

\n \n
\n```\n" }, "props": [ { "name": "contentBehind", "type": "boolean", "mutable": false, "attr": "content-behind", "reflectToAttr": true, "docs": "Positions the center content behind any `calcite-shell-panel`s.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [ { "name": "--calcite-shell-tip-spacing", "annotation": "prop", "docs": "The left and right spacing of the `calcite-tip-manager` when slotted in the component." } ], "slots": [ { "name": "", "docs": "A slot for adding content to the component. This content will appear between any leading and trailing panels added to the component, such as a map." }, { "name": "center-row", "docs": "A slot for adding content to the center row." }, { "name": "contextual-panel", "docs": "[DEPRECATED] A slot for adding the trailing `calcite-shell-panel`." }, { "name": "footer", "docs": "A slot for adding footer content. This content will be positioned at the bottom of the component." }, { "name": "header", "docs": "A slot for adding header content. This content will be positioned at the top of the component." }, { "name": "panel-end", "docs": "A slot for adding the ending `calcite-shell-panel`." }, { "name": "panel-start", "docs": "A slot for adding the starting `calcite-shell-panel`." }, { "name": "primary-panel", "docs": "[DEPRECATED] A slot for adding the leading `calcite-shell-panel`." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/shell-center-row/shell-center-row.tsx", "encapsulation": "shadow", "tag": "calcite-shell-center-row", "readme": "# calcite-shell-center-row\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding content to the `calcite-shell-panel`." }, { "name": "slot", "text": "action-bar - A slot for adding a `calcite-action-bar` to the `calcite-shell-panel`." } ], "usage": {}, "props": [ { "name": "detached", "type": "boolean", "mutable": false, "attr": "detached", "reflectToAttr": true, "docs": "When `true`, the content area displays like a floating panel.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "heightScale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "height-scale", "reflectToAttr": true, "docs": "Specifies the maximum height of the component.", "docsTags": [], "default": "\"s\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "position", "type": "\"end\" | \"start\"", "mutable": false, "attr": "position", "reflectToAttr": true, "docs": "Specifies the component's position. Will be flipped when the element direction is right-to-left (`\"rtl\"`).", "docsTags": [], "default": "\"end\"", "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding content to the `calcite-shell-panel`." }, { "name": "action-bar", "docs": "A slot for adding a `calcite-action-bar` to the `calcite-shell-panel`." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/shell-panel/shell-panel.tsx", "encapsulation": "shadow", "tag": "calcite-shell-panel", "readme": "# calcite-shell-panel\n\nThe `calcite-shell-panel` is a child component of `calcite-shell` used as a container to display other components like `calcite-block` and `calcite-flow`.\n", "docs": "The `calcite-shell-panel` is a child component of `calcite-shell` used as a container to display other components like `calcite-block` and `calcite-flow`.", "docsTags": [ { "name": "slot", "text": "- A slot for adding content to the component." }, { "name": "slot", "text": "action-bar - A slot for adding a `calcite-action-bar` to the component." } ], "usage": { "Basic": "Renders a basic shell panel with text content.\n\n```html\n\n

Primary Content

\n
\n```\n", "With-action-bar": "Renders a panel with an action bar.\n\n```html\n\n \n \n \n \n \n\n```\n", "With-custom-element": "Add `calcite-match-height` to a wrapping element to ensure proper height, scrolling, and sticky behavior (header, footer, fab). Note that multiple levels of nesting is not supported.\n\n```html\n\n \n \n \n \n \n \n ... \n \n\n```\n", "With-flow": "```html\n\n \n \n \n \n \n \n ... \n ... \n \n\n```\n", "With-panel": "```html\n\n \n \n \n \n \n ... \n\n```\n" }, "props": [ { "name": "collapsed", "type": "boolean", "mutable": false, "attr": "collapsed", "reflectToAttr": true, "docs": "When `true`, hides the component's content area.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "detached", "type": "boolean", "mutable": false, "attr": "detached", "reflectToAttr": true, "docs": "When `true`, the content area displays like a floating panel.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "detachedHeightScale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "detached-height-scale", "reflectToAttr": true, "docs": "When `detached`, specifies the maximum height of the component.", "docsTags": [], "default": "\"l\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "intlResize", "type": "string", "mutable": false, "attr": "intl-resize", "reflectToAttr": false, "docs": "Accessible name for the resize separator.", "docsTags": [ { "name": "default", "text": "\"Resize\"" } ], "default": "TEXT.resize", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "position", "type": "\"end\" | \"start\"", "mutable": false, "attr": "position", "reflectToAttr": true, "docs": "Specifies the component's position. Will be flipped when the element direction is right-to-left (`\"rtl\"`).", "docsTags": [], "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": false, "required": false }, { "name": "resizable", "type": "boolean", "mutable": false, "attr": "resizable", "reflectToAttr": true, "docs": "When `true` and not `detached`, the component's content area is resizable.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "widthScale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "width-scale", "reflectToAttr": true, "docs": "Specifies the width of the component's content area.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "calciteShellPanelToggle", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emitted when collapse has been toggled.", "docsTags": [ { "name": "deprecated", "text": "use a `ResizeObserver` on the component to listen for changes to its size." } ], "deprecation": "use a `ResizeObserver` on the component to listen for changes to its size." } ], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding content to the component." }, { "name": "action-bar", "docs": "A slot for adding a `calcite-action-bar` to the component." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/slider/slider.tsx", "encapsulation": "shadow", "tag": "calcite-slider", "readme": "# calcite-slider\n\nRange selection component for selecting single or multiple numeric values inside a given range.\n", "docs": "Range selection component for selecting single or multiple numeric values inside a given range.", "docsTags": [], "usage": { "Basic": "```html\n\n```\n", "Two-handles": "If you'd like to allow an upper and lower value selection (two handles), you can set `min-value` and `max-value` rather than `value`. Note: these are mutually exclusive.\n\n```html\n\n```\n" }, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "groupSeparator", "type": "boolean", "mutable": false, "attr": "group-separator", "reflectToAttr": true, "docs": "When `true`, number values are displayed with a group separator corresponding to the language and country format.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "hasHistogram", "type": "boolean", "mutable": true, "attr": "has-histogram", "reflectToAttr": true, "docs": "When `true`, indicates a histogram is present.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "histogram", "type": "Point[]", "mutable": false, "reflectToAttr": false, "docs": "A list of the histogram's x,y coordinates within the component's `min` and `max`. Displays above the component's track.", "docsTags": [ { "name": "see", "text": "[DataSeries](https://github.com/Esri/calcite-components/blob/master/src/components/graph/interfaces.ts#L5)" } ], "values": [ { "type": "Point[]" } ], "optional": true, "required": false }, { "name": "histogramStops", "type": "ColorStop[]", "mutable": false, "reflectToAttr": false, "docs": "A set of single color stops for a histogram, sorted by offset ascending.", "docsTags": [], "values": [ { "type": "ColorStop[]" } ], "optional": false, "required": false }, { "name": "labelHandles", "type": "boolean", "mutable": false, "attr": "label-handles", "reflectToAttr": true, "docs": "When `true`, displays label handles with their numeric value.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "labelTicks", "type": "boolean", "mutable": false, "attr": "label-ticks", "reflectToAttr": true, "docs": "When `true` and `ticks` is specified, displays label tick marks with their numeric value.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "max", "type": "number", "mutable": false, "attr": "max", "reflectToAttr": true, "docs": "The component's maximum selectable value.", "docsTags": [], "default": "100", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "maxLabel", "type": "string", "mutable": false, "attr": "max-label", "reflectToAttr": false, "docs": "For multiple selections, the accessible name for the second handle, such as `\"Temperature, upper bound\"`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "maxValue", "type": "number", "mutable": true, "attr": "max-value", "reflectToAttr": false, "docs": "For multiple selections, the component's upper value.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "min", "type": "number", "mutable": false, "attr": "min", "reflectToAttr": true, "docs": "The component's minimum selectable value.", "docsTags": [], "default": "0", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "minLabel", "type": "string", "mutable": false, "attr": "min-label", "reflectToAttr": false, "docs": "Accessible name for first (or only) handle, such as `\"Temperature, lower bound\"`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "minValue", "type": "number", "mutable": true, "attr": "min-value", "reflectToAttr": false, "docs": "For multiple selections, the component's lower value.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "mirrored", "type": "boolean", "mutable": false, "attr": "mirrored", "reflectToAttr": true, "docs": "When `true`, the slider will display values from high to low.\n\nNote that this value will be ignored if the slider has an associated histogram.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component on form submission.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "numberingSystem", "type": "\"arab\" | \"arabext\" | \"bali\" | \"beng\" | \"deva\" | \"fullwide\" | \"gujr\" | \"guru\" | \"hanidec\" | \"khmr\" | \"knda\" | \"laoo\" | \"latn\" | \"limb\" | \"mlym\" | \"mong\" | \"mymr\" | \"orya\" | \"tamldec\" | \"telu\" | \"thai\" | \"tibt\"", "mutable": false, "attr": "numbering-system", "reflectToAttr": false, "docs": "Specifies the Unicode numeral system used by the component for localization.", "docsTags": [], "values": [ { "value": "arab", "type": "string" }, { "value": "arabext", "type": "string" }, { "value": "bali", "type": "string" }, { "value": "beng", "type": "string" }, { "value": "deva", "type": "string" }, { "value": "fullwide", "type": "string" }, { "value": "gujr", "type": "string" }, { "value": "guru", "type": "string" }, { "value": "hanidec", "type": "string" }, { "value": "khmr", "type": "string" }, { "value": "knda", "type": "string" }, { "value": "laoo", "type": "string" }, { "value": "latn", "type": "string" }, { "value": "limb", "type": "string" }, { "value": "mlym", "type": "string" }, { "value": "mong", "type": "string" }, { "value": "mymr", "type": "string" }, { "value": "orya", "type": "string" }, { "value": "tamldec", "type": "string" }, { "value": "telu", "type": "string" }, { "value": "thai", "type": "string" }, { "value": "tibt", "type": "string" } ], "optional": true, "required": false }, { "name": "pageStep", "type": "number", "mutable": false, "attr": "page-step", "reflectToAttr": true, "docs": "Specifies the interval to move with the page up, or page down keys.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "precise", "type": "boolean", "mutable": false, "attr": "precise", "reflectToAttr": true, "docs": "When `true`, sets a finer point for handles.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "required", "type": "boolean", "mutable": false, "attr": "required", "reflectToAttr": true, "docs": "When `true`, the component must have a value in order for the form to submit.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "snap", "type": "boolean", "mutable": false, "attr": "snap", "reflectToAttr": true, "docs": "When `true`, enables snap selection in coordination with `step` via a mouse.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "step", "type": "number", "mutable": false, "attr": "step", "reflectToAttr": true, "docs": "Specifies the interval to move with the up, or down keys.", "docsTags": [], "default": "1", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "ticks", "type": "number", "mutable": false, "attr": "ticks", "reflectToAttr": true, "docs": "Displays tick marks on the number line at a specified interval.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "value", "type": "number | number[]", "mutable": true, "attr": "value", "reflectToAttr": true, "docs": "The component's value.", "docsTags": [], "default": "0", "values": [ { "type": "number" }, { "type": "number[]" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteSliderChange", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the thumb is released on the component.\n\n**Note:** If you need to constantly listen to the drag event,\nuse `calciteSliderInput` instead.", "docsTags": [] }, { "event": "calciteSliderInput", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires on all updates to the component.\n\n**Note:** Will be fired frequently during drag. If you are performing any\nexpensive operations consider using a debounce or throttle to avoid\nlocking up the main thread.", "docsTags": [] }, { "event": "calciteSliderUpdate", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires on all updates to the component.\n\n**Note:** Will be fired frequently during drag. If you are performing any\nexpensive operations consider using a debounce or throttle to avoid\nlocking up the main thread.", "docsTags": [ { "name": "deprecated", "text": "use `calciteSliderInput` instead." } ], "deprecation": "use `calciteSliderInput` instead." } ], "listeners": [ { "event": "keydown", "capture": false, "passive": false }, { "event": "pointerdown", "capture": false, "passive": true } ], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [ "calcite-graph" ], "dependencyGraph": { "calcite-slider": [ "calcite-graph" ] } }, { "filePath": "./src/components/sortable-list/sortable-list.tsx", "encapsulation": "shadow", "tag": "calcite-sortable-list", "readme": "# calcite-sortable-list\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding sortable items." } ], "usage": {}, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When true, disabled prevents interaction. This state shows items with lower opacity/grayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "dragSelector", "type": "string", "mutable": false, "attr": "drag-selector", "reflectToAttr": true, "docs": "Specifies which items inside the element should be draggable.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "group", "type": "string", "mutable": false, "attr": "group", "reflectToAttr": true, "docs": "The list's group identifier.\n\nTo drag elements from one list into another, both lists must have the same group value.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "handleSelector", "type": "string", "mutable": false, "attr": "handle-selector", "reflectToAttr": true, "docs": "The selector for the handle elements.", "docsTags": [], "default": "\"calcite-handle\"", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "layout", "type": "\"grid\" | \"horizontal\" | \"vertical\"", "mutable": false, "attr": "layout", "reflectToAttr": true, "docs": "Indicates the horizontal or vertical orientation of the component.", "docsTags": [], "default": "\"vertical\"", "values": [ { "value": "grid", "type": "string" }, { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": false, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When true, content is waiting to be loaded. This state shows a busy indicator.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "calciteListOrderChange", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emitted when the order of the list has changed.", "docsTags": [] } ], "listeners": [ { "event": "calciteHandleNudge", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding sortable items." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/split-button/split-button.tsx", "encapsulation": "shadow", "tag": "calcite-split-button", "readme": "# calcite-split-button\n\nThe calcite-split-button control is one that combines a button with a dropdown menu in order to provide a primary action along with one or more related secondary options / actions. It's useful for grouping related actions or options for users, while elevating a commonly-used or default action for easier access. Its inner content populates the control's dropdown menu, and is thus expected to be valid `calcite-dropdown` content.\n", "docs": "The calcite-split-button control is one that combines a button with a dropdown menu in order to provide a primary action along with one or more related secondary options / actions. It's useful for grouping related actions or options for users, while elevating a commonly-used or default action for easier access. Its inner content populates the control's dropdown menu, and is thus expected to be valid `calcite-dropdown` content.", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-dropdown` content." } ], "usage": { "Basic": "```html\n\n \n Option 2\n Option 3\n Option 4\n \n\n```\n" }, "props": [ { "name": "appearance", "type": "\"clear\" | \"minimal\" | \"outline\" | \"solid\" | \"transparent\"", "mutable": false, "attr": "appearance", "reflectToAttr": true, "docs": "Specifies the appearance style of the component.", "docsTags": [], "default": "\"solid\"", "values": [ { "value": "clear", "type": "string" }, { "value": "minimal", "type": "string" }, { "value": "outline", "type": "string" }, { "value": "solid", "type": "string" }, { "value": "transparent", "type": "string" } ], "optional": false, "required": false }, { "name": "color", "type": "\"blue\" | \"inverse\" | \"neutral\" | \"red\"", "mutable": false, "attr": "color", "reflectToAttr": true, "docs": "Specifies the color of the component.", "docsTags": [], "default": "\"blue\"", "values": [ { "value": "blue", "type": "string" }, { "value": "inverse", "type": "string" }, { "value": "neutral", "type": "string" }, { "value": "red", "type": "string" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "dropdownIconType", "type": "\"caret\" | \"chevron\" | \"ellipsis\" | \"overflow\"", "mutable": false, "attr": "dropdown-icon-type", "reflectToAttr": true, "docs": "Specifies the icon used for the dropdown menu.", "docsTags": [], "default": "\"chevron\"", "values": [ { "value": "caret", "type": "string" }, { "value": "chevron", "type": "string" }, { "value": "ellipsis", "type": "string" }, { "value": "overflow", "type": "string" } ], "optional": false, "required": false }, { "name": "dropdownLabel", "type": "string", "mutable": false, "attr": "dropdown-label", "reflectToAttr": true, "docs": "Accessible name for the dropdown menu.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When `true`, a busy indicator is displayed on the primary button.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "overlayPositioning", "type": "\"absolute\" | \"fixed\"", "mutable": false, "attr": "overlay-positioning", "reflectToAttr": true, "docs": "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\"`.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "type": "string" } ], "optional": false, "required": false }, { "name": "primaryIconEnd", "type": "string", "mutable": false, "attr": "primary-icon-end", "reflectToAttr": true, "docs": "Specifies an icon to display at the end of the primary button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "primaryIconFlipRtl", "type": "\"both\" | \"end\" | \"start\"", "mutable": false, "attr": "primary-icon-flip-rtl", "reflectToAttr": true, "docs": "When `true`, the primary button icon will be flipped when the element direction is right-to-left (`\"rtl\"`).", "docsTags": [], "values": [ { "value": "both", "type": "string" }, { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": true, "required": false }, { "name": "primaryIconStart", "type": "string", "mutable": false, "attr": "primary-icon-start", "reflectToAttr": true, "docs": "Specifies an icon to display at the start of the primary button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "primaryLabel", "type": "string", "mutable": false, "attr": "primary-label", "reflectToAttr": true, "docs": "Accessible name for the primary button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "primaryText", "type": "string", "mutable": false, "attr": "primary-text", "reflectToAttr": true, "docs": "Text displayed in the primary button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "width", "type": "\"auto\" | \"full\" | \"half\"", "mutable": false, "attr": "width", "reflectToAttr": true, "docs": "Specifies the width of the component.", "docsTags": [], "default": "\"auto\"", "values": [ { "value": "auto", "type": "string" }, { "value": "full", "type": "string" }, { "value": "half", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "calciteSplitButtonPrimaryClick", "detail": "any", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the primary button is clicked.\n\n**Note:** The event payload is deprecated, use separate mouse event listeners to get info about click.", "docsTags": [] }, { "event": "calciteSplitButtonSecondaryClick", "detail": "any", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the dropdown menu is clicked.\n\n**Note:** The event payload is deprecated, use separate mouse event listeners to get info about click.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-dropdown` content." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-button", "calcite-dropdown" ], "dependencyGraph": { "calcite-split-button": [ "calcite-button", "calcite-dropdown" ], "calcite-button": [ "calcite-loader", "calcite-icon" ] } }, { "filePath": "./src/components/stepper/stepper.tsx", "encapsulation": "shadow", "tag": "calcite-stepper", "readme": "# calcite-stepper\n\nCalcite stepper can be used to present a stepper workflow to a user. It has configurable display options for layout (horizontal or vertical), and the ability to automatically render status icons, and step numbers.\n", "docs": "Calcite stepper can be used to present a stepper workflow to a user. It has configurable display options for layout (horizontal or vertical), and the ability to automatically render status icons, and step numbers.", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-stepper-item`s." } ], "usage": { "Basic": "```html\n\n \n Step 1 Content Goes Here\n \n Step 2 Content Goes Here \n \n Step 3 Content Goes Here\n \n \n Step 4 Content Goes Here\n \n\n```\n" }, "props": [ { "name": "icon", "type": "boolean", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "When `true`, displays a status icon in the `calcite-stepper-item` heading.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "layout", "type": "\"horizontal\" | \"vertical\"", "mutable": false, "attr": "layout", "reflectToAttr": true, "docs": "Defines the layout of the component.", "docsTags": [], "default": "\"horizontal\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": false, "required": false }, { "name": "numbered", "type": "boolean", "mutable": false, "attr": "numbered", "reflectToAttr": true, "docs": "When `true`, displays the step number in the `calcite-stepper-item` heading.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "numberingSystem", "type": "\"arab\" | \"arabext\" | \"bali\" | \"beng\" | \"deva\" | \"fullwide\" | \"gujr\" | \"guru\" | \"hanidec\" | \"khmr\" | \"knda\" | \"laoo\" | \"latn\" | \"limb\" | \"mlym\" | \"mong\" | \"mymr\" | \"orya\" | \"tamldec\" | \"telu\" | \"thai\" | \"tibt\"", "mutable": false, "attr": "numbering-system", "reflectToAttr": true, "docs": "Specifies the Unicode numeral system used by the component for localization.", "docsTags": [], "values": [ { "value": "arab", "type": "string" }, { "value": "arabext", "type": "string" }, { "value": "bali", "type": "string" }, { "value": "beng", "type": "string" }, { "value": "deva", "type": "string" }, { "value": "fullwide", "type": "string" }, { "value": "gujr", "type": "string" }, { "value": "guru", "type": "string" }, { "value": "hanidec", "type": "string" }, { "value": "khmr", "type": "string" }, { "value": "knda", "type": "string" }, { "value": "laoo", "type": "string" }, { "value": "latn", "type": "string" }, { "value": "limb", "type": "string" }, { "value": "mlym", "type": "string" }, { "value": "mong", "type": "string" }, { "value": "mymr", "type": "string" }, { "value": "orya", "type": "string" }, { "value": "tamldec", "type": "string" }, { "value": "telu", "type": "string" }, { "value": "thai", "type": "string" }, { "value": "tibt", "type": "string" } ], "optional": true, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "endStep", "returns": { "type": "Promise", "docs": "" }, "signature": "endStep() => Promise", "parameters": [], "docs": "Set the last `calcite-stepper-item` as active.", "docsTags": [] }, { "name": "goToStep", "returns": { "type": "Promise", "docs": "" }, "signature": "goToStep(step: number) => Promise", "parameters": [], "docs": "Set a specified `calcite-stepper-item` as active.", "docsTags": [ { "name": "param", "text": "step" } ] }, { "name": "nextStep", "returns": { "type": "Promise", "docs": "" }, "signature": "nextStep() => Promise", "parameters": [], "docs": "Set the next `calcite-stepper-item` as active.", "docsTags": [] }, { "name": "prevStep", "returns": { "type": "Promise", "docs": "" }, "signature": "prevStep() => Promise", "parameters": [], "docs": "Set the previous `calcite-stepper-item` as active.", "docsTags": [] }, { "name": "startStep", "returns": { "type": "Promise", "docs": "" }, "signature": "startStep() => Promise", "parameters": [], "docs": "Set the first `calcite-stepper-item` as active.", "docsTags": [] } ], "events": [ { "event": "calciteStepperItemChange", "detail": "StepperItemChangeEventDetail", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the active `calcite-stepper-item` changes.", "docsTags": [] } ], "listeners": [ { "event": "calciteInternalStepperItemKeyEvent", "capture": false, "passive": false }, { "event": "calciteInternalStepperItemRegister", "capture": false, "passive": false }, { "event": "calciteInternalStepperItemSelect", "capture": false, "passive": false }, { "event": "calciteInternalUserRequestedStepperItemSelect", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-stepper-item`s." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/stepper-item/stepper-item.tsx", "encapsulation": "shadow", "tag": "calcite-stepper-item", "readme": "# calcite-stepper-item\n\nindividual `calcite-stepper-item` item\n", "docs": "individual `calcite-stepper-item` item", "docsTags": [ { "name": "slot", "text": "- A slot for adding custom content." } ], "usage": {}, "props": [ { "name": "active", "type": "boolean", "mutable": true, "attr": "active", "reflectToAttr": true, "docs": "When `true`, the component is selected.", "docsTags": [ { "name": "deprecated", "text": "Use `selected` instead." } ], "default": "false", "deprecation": "Use `selected` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "complete", "type": "boolean", "mutable": false, "attr": "complete", "reflectToAttr": true, "docs": "When `true`, the step has been completed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": false, "docs": "A description for the component. Displays below the header text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "error", "type": "boolean", "mutable": false, "attr": "error", "reflectToAttr": true, "docs": "When `true`, the component contains an error that requires resolution from the user.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "heading", "type": "string", "mutable": false, "attr": "heading", "reflectToAttr": false, "docs": "The component header text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "itemSubtitle", "type": "string", "mutable": false, "attr": "item-subtitle", "reflectToAttr": false, "docs": "A description for the component. Displays below the header text.", "docsTags": [ { "name": "deprecated", "text": "use `description` instead." } ], "deprecation": "use `description` instead.", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "itemTitle", "type": "string", "mutable": false, "attr": "item-title", "reflectToAttr": false, "docs": "The component header text.", "docsTags": [ { "name": "deprecated", "text": "use `heading` instead." } ], "deprecation": "use `heading` instead.", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "selected", "type": "boolean", "mutable": true, "attr": "selected", "reflectToAttr": true, "docs": "When `true`, the component is selected.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [], "listeners": [ { "event": "calciteInternalStepperItemChange", "target": "body", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding custom content." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-icon" ], "dependencyGraph": { "calcite-stepper-item": [ "calcite-icon" ] } }, { "filePath": "./src/components/switch/switch.tsx", "encapsulation": "shadow", "tag": "calcite-switch", "readme": "# calcite-switch\n\n`calcite-switch` is used to toggle a value on or off.\n", "docs": "`calcite-switch` is used to toggle a value on or off.", "docsTags": [], "usage": { "Basic": "```html\n\n```\n" }, "props": [ { "name": "checked", "type": "boolean", "mutable": true, "attr": "checked", "reflectToAttr": true, "docs": "When `true`, the component is checked.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Accessible name for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "name", "type": "string", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component on form submission.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "switched", "type": "boolean", "mutable": true, "attr": "switched", "reflectToAttr": true, "docs": "When `true`, the component is checked.", "docsTags": [ { "name": "deprecated", "text": "use `checked` instead." } ], "default": "false", "deprecation": "use `checked` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "any", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The component's value.", "docsTags": [], "values": [ { "type": "any" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteSwitchChange", "detail": "any", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the `checked` value has changed.\n\n**Note:** The event payload is deprecated, use the component's `checked` property instead.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [], "parts": [], "dependents": [ "calcite-block-section" ], "dependencies": [], "dependencyGraph": { "calcite-block-section": [ "calcite-switch" ] } }, { "filePath": "./src/components/tab/tab.tsx", "encapsulation": "shadow", "tag": "calcite-tab", "readme": "# calcite-tab\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding content to the component." } ], "usage": { "Basic": "`calcite-tab` wraps the content you would like to appear when that tab is selected:\n\n```html\nMy stuff!\n```\n" }, "props": [ { "name": "active", "type": "boolean", "mutable": true, "attr": "active", "reflectToAttr": true, "docs": "When `true`, the component's contents are selected.\n\nOnly one tab can be selected within the `calcite-tabs` parent.", "docsTags": [ { "name": "deprecated", "text": "Use `selected` instead." } ], "default": "false", "deprecation": "Use `selected` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "selected", "type": "boolean", "mutable": true, "attr": "selected", "reflectToAttr": true, "docs": "When `true`, the component's contents are selected.\n\nOnly one tab can be selected within the `calcite-tabs` parent.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "tab", "type": "string", "mutable": false, "attr": "tab", "reflectToAttr": true, "docs": "Specifies a unique name for the component.\n\nWhen specified, use the same value on the `calcite-tab-title`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [ { "name": "getTabIndex", "returns": { "type": "Promise", "docs": "" }, "signature": "getTabIndex() => Promise", "parameters": [], "docs": "Returns the index of the component item within the tab array.", "docsTags": [] } ], "events": [], "listeners": [ { "event": "calciteInternalTabChange", "target": "body", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding content to the component." } ], "parts": [], "dependents": [ "calcite-color-picker" ], "dependencies": [], "dependencyGraph": { "calcite-color-picker": [ "calcite-tab" ] } }, { "filePath": "./src/components/tab-nav/tab-nav.tsx", "encapsulation": "shadow", "tag": "calcite-tab-nav", "readme": "# calcite-tab-nav\n\nThe tab-nav groups several [calcite-tab-title](../tab-title) components and builds out the navigation. You can optionally use attibutes on the tab-nav to configure client side storage of the selected tab.\n", "docs": "The tab-nav groups several [calcite-tab-title](../tab-title) components and builds out the navigation. You can optionally use attibutes on the tab-nav to configure client side storage of the selected tab.", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-tab-title`s." } ], "usage": { "Basic": "When tab-nav is the only parent, tab-title can inherit its `scale` and `position` from tab-nav:\n\n```html\n\n Layers\n Maps\n Data\n\n```\n" }, "props": [ { "name": "storageId", "type": "string", "mutable": false, "attr": "storage-id", "reflectToAttr": true, "docs": "Specifies the name when saving selected `calcite-tab` data to `localStorage`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "syncId", "type": "string", "mutable": false, "attr": "sync-id", "reflectToAttr": true, "docs": "Specifies text to update multiple components to keep in sync if one changes.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "calciteTabChange", "detail": "TabChangeEventDetail", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the selected `calcite-tab` changes.", "docsTags": [ { "name": "see", "text": "[TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)" } ] } ], "listeners": [ { "event": "calciteInternalTabsFocusPrevious", "capture": false, "passive": false }, { "event": "calciteInternalTabsFocusNext", "capture": false, "passive": false }, { "event": "calciteInternalTabsActivate", "capture": false, "passive": false }, { "event": "calciteTabsActivate", "capture": false, "passive": false }, { "event": "calciteInternalTabTitleRegister", "capture": false, "passive": false }, { "event": "calciteInternalTabChange", "target": "body", "capture": false, "passive": false }, { "event": "calciteInternalTabIconChanged", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-tab-title`s." } ], "parts": [], "dependents": [ "calcite-color-picker" ], "dependencies": [], "dependencyGraph": { "calcite-color-picker": [ "calcite-tab-nav" ] } }, { "filePath": "./src/components/tab-title/tab-title.tsx", "encapsulation": "shadow", "tag": "calcite-tab-title", "readme": "# calcite-tab-title\n\nThe tab-title is the link that switches between panes in [calcite-tabs](../tabs).\n", "docs": "The tab-title is the link that switches between panes in [calcite-tabs](../tabs).", "docsTags": [ { "name": "slot", "text": "- A slot for adding text." } ], "usage": {}, "props": [ { "name": "active", "type": "boolean", "mutable": true, "attr": "active", "reflectToAttr": true, "docs": "When `true`, the component and its respective `calcite-tab` contents are selected.\n\nOnly one tab can be selected within the `calcite-tabs` parent.", "docsTags": [ { "name": "deprecated", "text": "Use `selected` instead." } ], "default": "false", "deprecation": "Use `selected` instead.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "iconEnd", "type": "string", "mutable": false, "attr": "icon-end", "reflectToAttr": true, "docs": "Specifies an icon to display at the end of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "iconFlipRtl", "type": "\"both\" | \"end\" | \"start\"", "mutable": false, "attr": "icon-flip-rtl", "reflectToAttr": true, "docs": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`).", "docsTags": [], "values": [ { "value": "both", "type": "string" }, { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": true, "required": false }, { "name": "iconStart", "type": "string", "mutable": false, "attr": "icon-start", "reflectToAttr": true, "docs": "Specifies an icon to display at the start of the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "selected", "type": "boolean", "mutable": true, "attr": "selected", "reflectToAttr": true, "docs": "When `true`, the component and its respective `calcite-tab` contents are selected.\n\nOnly one tab can be selected within the `calcite-tabs` parent.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "tab", "type": "string", "mutable": false, "attr": "tab", "reflectToAttr": true, "docs": "Specifies a unique name for the component.\n\nWhen specified, use the same value on the `calcite-tab`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [ { "name": "getTabIndex", "returns": { "type": "Promise", "docs": "" }, "signature": "getTabIndex() => Promise", "parameters": [], "docs": "Returns the index of the title within the `calcite-tab-nav`.", "docsTags": [] } ], "events": [ { "event": "calciteTabsActivate", "detail": "TabChangeEventDetail", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when a `calcite-tab` is selected. Emits the `tab` property, or the index position.", "docsTags": [ { "name": "see", "text": "[TabChangeEventDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tab/interfaces.ts#L1)" } ] } ], "listeners": [ { "event": "calciteInternalTabChange", "target": "body", "capture": false, "passive": false }, { "event": "click", "capture": false, "passive": false }, { "event": "keydown", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding text." } ], "parts": [], "dependents": [ "calcite-color-picker" ], "dependencies": [ "calcite-icon" ], "dependencyGraph": { "calcite-tab-title": [ "calcite-icon" ], "calcite-color-picker": [ "calcite-tab-title" ] } }, { "filePath": "./src/components/tabs/tabs.tsx", "encapsulation": "shadow", "tag": "calcite-tabs", "readme": "# calcite-tabs\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-tab`s." }, { "name": "slot", "text": "tab-nav - A slot for adding a `calcite-tab-nav`." } ], "usage": { "Basic": "`calcite-tabs` uses several sub-components ([calcite-tab-nav](../tab-nav), [calcite-tab](../tab), [calcite-tab-title](../tab-title)) to create a tabbed interface with optional client side storage. Place your content inside of the `` element:\n\n```html\n\n \n Tab 1 Title\n Tab 2 Title\n \n\n Tab 1 Content\n Tab 2 Content\n\n```\n", "Bordered": "```html\n\n \n Tab 1 Title\n Tab 2 Title\n Tab 3 Title\n Tab 4 Title\n \n Tab 1 Content\n Tab 2 Content\n Tab 3 Content\n Tab 4 Content\n\n```\n" }, "props": [ { "name": "bordered", "type": "boolean", "mutable": true, "attr": "bordered", "reflectToAttr": true, "docs": "When `true`, the component will display with a folder style menu.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "layout", "type": "\"center\" | \"inline\"", "mutable": false, "attr": "layout", "reflectToAttr": true, "docs": "Specifies the layout of the `calcite-tab-nav`, justifying the `calcite-tab-title`s to the start (`\"inline\"`), or across and centered (`\"center\"`).", "docsTags": [], "default": "\"inline\"", "values": [ { "value": "center", "type": "string" }, { "value": "inline", "type": "string" } ], "optional": false, "required": false }, { "name": "position", "type": "\"above\" | \"below\" | \"bottom\" | \"top\"", "mutable": false, "attr": "position", "reflectToAttr": true, "docs": "Specifies the position of the component in relation to the `calcite-tab`s. The `\"above\"` and `\"below\"` values are deprecated.", "docsTags": [], "default": "\"top\"", "values": [ { "value": "above", "type": "string" }, { "value": "below", "type": "string" }, { "value": "bottom", "type": "string" }, { "value": "top", "type": "string" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [ { "event": "calciteInternalTabTitleRegister", "capture": false, "passive": false }, { "event": "calciteTabTitleUnregister", "target": "body", "capture": false, "passive": false }, { "event": "calciteInternalTabRegister", "capture": false, "passive": false }, { "event": "calciteTabUnregister", "target": "body", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-tab`s." }, { "name": "tab-nav", "docs": "A slot for adding a `calcite-tab-nav`." } ], "parts": [], "dependents": [ "calcite-color-picker" ], "dependencies": [], "dependencyGraph": { "calcite-color-picker": [ "calcite-tabs" ] } }, { "filePath": "./src/components/tile/tile.tsx", "encapsulation": "shadow", "tag": "calcite-tile", "readme": "# calcite-tile\n", "docs": "", "docsTags": [ { "name": "slot", "text": "content-start - A slot for adding non-actionable elements before the component's content." }, { "name": "slot", "text": "content-end - A slot for adding non-actionable elements after the component's content." } ], "usage": { "Basic": "```html\n\n```\n" }, "props": [ { "name": "active", "type": "boolean", "mutable": false, "attr": "active", "reflectToAttr": true, "docs": "When `true`, the component is active.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": true, "docs": "A description for the component, which displays below the heading.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "embed", "type": "boolean", "mutable": false, "attr": "embed", "reflectToAttr": true, "docs": "The component's embed mode.\n\nWhen `true`, renders without a border and padding for use by other components.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "heading", "type": "string", "mutable": false, "attr": "heading", "reflectToAttr": true, "docs": "The component header text, which displays between the icon and description.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "hidden", "type": "boolean", "mutable": false, "attr": "hidden", "reflectToAttr": true, "docs": "When `true`, the component is not displayed and is not focusable.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "href", "type": "string", "mutable": false, "attr": "href", "reflectToAttr": true, "docs": "When embed is `\"false\"`, the URL for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "icon", "type": "string", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "Specifies an icon to display.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "content-end", "docs": "A slot for adding non-actionable elements after the component's content." }, { "name": "content-start", "docs": "A slot for adding non-actionable elements before the component's content." } ], "parts": [], "dependents": [ "calcite-tile-select" ], "dependencies": [ "calcite-icon", "calcite-link" ], "dependencyGraph": { "calcite-tile": [ "calcite-icon", "calcite-link" ], "calcite-link": [ "calcite-icon" ], "calcite-tile-select": [ "calcite-tile" ] } }, { "filePath": "./src/components/tile-select/tile-select.tsx", "encapsulation": "shadow", "tag": "calcite-tile-select", "readme": "# calcite-tile-select\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding custom content." } ], "usage": { "Basic": "```html\n\n```\n" }, "props": [ { "name": "checked", "type": "boolean", "mutable": true, "attr": "checked", "reflectToAttr": true, "docs": "When `true`, the component is checked.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": true, "docs": "A description for the component, which displays below the heading.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "heading", "type": "string", "mutable": false, "attr": "heading", "reflectToAttr": true, "docs": "The component header text, which displays between the icon and description.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "hidden", "type": "boolean", "mutable": false, "attr": "hidden", "reflectToAttr": true, "docs": "When `true`, the component is not displayed and is not focusable or checkable.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "icon", "type": "string", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "Specifies an icon to display.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "inputAlignment", "type": "\"end\" | \"start\"", "mutable": false, "attr": "input-alignment", "reflectToAttr": true, "docs": "When `inputEnabled` is `true`, specifies the placement of the interactive input on the component.", "docsTags": [], "default": "\"start\"", "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": false, "required": false }, { "name": "inputEnabled", "type": "boolean", "mutable": false, "attr": "input-enabled", "reflectToAttr": true, "docs": "When `true`, displays an interactive input based on the `type` property.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "name", "type": "any", "mutable": false, "attr": "name", "reflectToAttr": true, "docs": "Specifies the name of the component on form submission.", "docsTags": [], "values": [ { "type": "any" } ], "optional": false, "required": false }, { "name": "type", "type": "\"checkbox\" | \"radio\"", "mutable": false, "attr": "type", "reflectToAttr": true, "docs": "The selection mode of the component.\n\nUse radio for single selection, and checkbox for multiple selections.", "docsTags": [], "default": "\"radio\"", "values": [ { "value": "checkbox", "type": "string" }, { "value": "radio", "type": "string" } ], "optional": false, "required": false }, { "name": "value", "type": "any", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The component's value.", "docsTags": [], "values": [ { "type": "any" } ], "optional": true, "required": false }, { "name": "width", "type": "\"auto\" | \"full\"", "mutable": false, "attr": "width", "reflectToAttr": true, "docs": "Specifies the width of the component.", "docsTags": [], "default": "\"auto\"", "values": [ { "value": "auto", "type": "string" }, { "value": "full", "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [] } ], "events": [ { "event": "calciteTileSelectChange", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits a custom change event.\n\nFor checkboxes it emits when checked or unchecked.\n\nFor radios it only emits when checked.", "docsTags": [] } ], "listeners": [ { "event": "calciteCheckboxChange", "capture": false, "passive": false }, { "event": "calciteInternalCheckboxFocus", "capture": false, "passive": false }, { "event": "calciteInternalCheckboxBlur", "capture": false, "passive": false }, { "event": "calciteRadioButtonChange", "capture": false, "passive": false }, { "event": "calciteInternalRadioButtonCheckedChange", "capture": false, "passive": false }, { "event": "calciteInternalRadioButtonFocus", "capture": false, "passive": false }, { "event": "calciteInternalRadioButtonBlur", "capture": false, "passive": false }, { "event": "click", "capture": false, "passive": false }, { "event": "pointerenter", "capture": false, "passive": true }, { "event": "pointerleave", "capture": false, "passive": true } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding custom content." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-tile" ], "dependencyGraph": { "calcite-tile-select": [ "calcite-tile" ], "calcite-tile": [ "calcite-icon", "calcite-link" ], "calcite-link": [ "calcite-icon" ] } }, { "filePath": "./src/components/tile-select-group/tile-select-group.tsx", "encapsulation": "shadow", "tag": "calcite-tile-select-group", "readme": "# calcite-tile-select-group\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-tile-select`s." } ], "usage": {}, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "layout", "type": "\"horizontal\" | \"vertical\"", "mutable": false, "attr": "layout", "reflectToAttr": true, "docs": "Defines the layout of the component.\n\nUse `\"horizontal\"` for rows, and `\"vertical\"` for a single column.", "docsTags": [], "default": "\"horizontal\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-tile-select`s." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/time-picker/time-picker.tsx", "encapsulation": "shadow", "tag": "calcite-time-picker", "readme": "# calcite-time-picker\n", "docs": "", "docsTags": [], "usage": {}, "props": [ { "name": "intlHour", "type": "string", "mutable": false, "attr": "intl-hour", "reflectToAttr": false, "docs": "Accessible name for the component's hour input.", "docsTags": [ { "name": "default", "text": "\"Hour\"" } ], "default": "TEXT.hour", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlHourDown", "type": "string", "mutable": false, "attr": "intl-hour-down", "reflectToAttr": false, "docs": "Accessible name for the component's hour down button.", "docsTags": [ { "name": "default", "text": "\"Decrease hour\"" } ], "default": "TEXT.hourDown", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlHourUp", "type": "string", "mutable": false, "attr": "intl-hour-up", "reflectToAttr": false, "docs": "Accessible name for the component's hour up button.", "docsTags": [ { "name": "default", "text": "\"Increase hour\"" } ], "default": "TEXT.hourUp", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlMeridiem", "type": "string", "mutable": false, "attr": "intl-meridiem", "reflectToAttr": false, "docs": "Accessible name for the component's meridiem (AM/PM) input.", "docsTags": [ { "name": "default", "text": "\"AM/PM\"" } ], "default": "TEXT.meridiem", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlMeridiemDown", "type": "string", "mutable": false, "attr": "intl-meridiem-down", "reflectToAttr": false, "docs": "Accessible name for the component's meridiem (AM/PM) down button.", "docsTags": [ { "name": "default", "text": "\"Decrease AM/PM\"" } ], "default": "TEXT.meridiemDown", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlMeridiemUp", "type": "string", "mutable": false, "attr": "intl-meridiem-up", "reflectToAttr": false, "docs": "Accessible name for the component's meridiem (AM/PM) up button.", "docsTags": [ { "name": "default", "text": "\"Increase AM/PM\"" } ], "default": "TEXT.meridiemUp", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlMinute", "type": "string", "mutable": false, "attr": "intl-minute", "reflectToAttr": false, "docs": "Accessible name for the component's minute input.", "docsTags": [ { "name": "default", "text": "\"Minute\"" } ], "default": "TEXT.minute", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlMinuteDown", "type": "string", "mutable": false, "attr": "intl-minute-down", "reflectToAttr": false, "docs": "Accessible name for the component's minute down button.", "docsTags": [ { "name": "default", "text": "\"Decrease minute\"" } ], "default": "TEXT.minuteDown", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlMinuteUp", "type": "string", "mutable": false, "attr": "intl-minute-up", "reflectToAttr": false, "docs": "Accessible name for the component's minute up button.", "docsTags": [ { "name": "default", "text": "\"Increase minute\"" } ], "default": "TEXT.minuteUp", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlSecond", "type": "string", "mutable": false, "attr": "intl-second", "reflectToAttr": false, "docs": "Accessible name for the component's second input.", "docsTags": [ { "name": "default", "text": "\"Second\"" } ], "default": "TEXT.second", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlSecondDown", "type": "string", "mutable": false, "attr": "intl-second-down", "reflectToAttr": false, "docs": "Accessible name for the component's second down button.", "docsTags": [ { "name": "default", "text": "\"Decrease second\"" } ], "default": "TEXT.secondDown", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "intlSecondUp", "type": "string", "mutable": false, "attr": "intl-second-up", "reflectToAttr": false, "docs": "Accessible name for the component's second up button.", "docsTags": [ { "name": "default", "text": "\"Increase second\"" } ], "default": "TEXT.secondUp", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "numberingSystem", "type": "\"arab\" | \"arabext\" | \"bali\" | \"beng\" | \"deva\" | \"fullwide\" | \"gujr\" | \"guru\" | \"hanidec\" | \"khmr\" | \"knda\" | \"laoo\" | \"latn\" | \"limb\" | \"mlym\" | \"mong\" | \"mymr\" | \"orya\" | \"tamldec\" | \"telu\" | \"thai\" | \"tibt\"", "mutable": false, "attr": "numbering-system", "reflectToAttr": false, "docs": "Specifies the Unicode numeral system used by the component for localization.", "docsTags": [], "values": [ { "value": "arab", "type": "string" }, { "value": "arabext", "type": "string" }, { "value": "bali", "type": "string" }, { "value": "beng", "type": "string" }, { "value": "deva", "type": "string" }, { "value": "fullwide", "type": "string" }, { "value": "gujr", "type": "string" }, { "value": "guru", "type": "string" }, { "value": "hanidec", "type": "string" }, { "value": "khmr", "type": "string" }, { "value": "knda", "type": "string" }, { "value": "laoo", "type": "string" }, { "value": "latn", "type": "string" }, { "value": "limb", "type": "string" }, { "value": "mlym", "type": "string" }, { "value": "mong", "type": "string" }, { "value": "mymr", "type": "string" }, { "value": "orya", "type": "string" }, { "value": "tamldec", "type": "string" }, { "value": "telu", "type": "string" }, { "value": "thai", "type": "string" }, { "value": "tibt", "type": "string" } ], "optional": true, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": false, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "step", "type": "number", "mutable": false, "attr": "step", "reflectToAttr": true, "docs": "Specifies the granularity the `value` must adhere to (in seconds).", "docsTags": [], "default": "60", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The component's value in UTC (always 24-hour format).", "docsTags": [], "default": "null", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus(target: TimePart) => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [ { "name": "param", "text": "target" } ] } ], "events": [], "listeners": [ { "event": "blur", "capture": false, "passive": false }, { "event": "focus", "capture": false, "passive": false }, { "event": "keydown", "capture": false, "passive": false } ], "styles": [], "slots": [], "parts": [], "dependents": [ "calcite-input-time-picker" ], "dependencies": [ "calcite-icon" ], "dependencyGraph": { "calcite-time-picker": [ "calcite-icon" ], "calcite-input-time-picker": [ "calcite-time-picker" ] } }, { "filePath": "./src/components/tip/tip.tsx", "encapsulation": "shadow", "tag": "calcite-tip", "readme": "# calcite-tip\n\nThe `calcite-tip` component can comprise of an image, text and hyperlink to give helpful hints to a user about using the platform.\n", "docs": "The `calcite-tip` component can comprise of an image, text and hyperlink to give helpful hints to a user about using the platform.", "docsTags": [ { "name": "slot", "text": "- A slot for adding text and a hyperlink." }, { "name": "slot", "text": "thumbnail - A slot for adding an HTML image element." } ], "usage": { "Basic": "Renders a non-dismissible tip with a heading, thumbnail, info and a link.\n\n```html\n\n \"This\n

Normal tip with a landscape or square image and a small amount of text in the \"info\" slot.

\n
Put a link hurr!\n\n```\n" }, "props": [ { "name": "dismissed", "type": "boolean", "mutable": true, "attr": "dismissed", "reflectToAttr": true, "docs": "When `true`, the component does not display.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "heading", "type": "string", "mutable": false, "attr": "heading", "reflectToAttr": false, "docs": "The component header text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "1 | 2 | 3 | 4 | 5 | 6", "mutable": false, "attr": "heading-level", "reflectToAttr": true, "docs": "Specifies the number at which section headings should start.", "docsTags": [], "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "optional": false, "required": false }, { "name": "intlClose", "type": "string", "mutable": false, "attr": "intl-close", "reflectToAttr": false, "docs": "Accessible name for the component's close button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "nonDismissible", "type": "boolean", "mutable": false, "attr": "non-dismissible", "reflectToAttr": true, "docs": "When `true`, the close button is not present on the component.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "selected", "type": "boolean", "mutable": false, "attr": "selected", "reflectToAttr": true, "docs": "When `true`, the component is selected if it has a parent `calcite-tip-manager`.\n\nOnly one tip can be selected within the `calcite-tip-manager` parent.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "calciteTipDismiss", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the component has been dismissed.", "docsTags": [] } ], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding text and a hyperlink." }, { "name": "thumbnail", "docs": "A slot for adding an HTML image element." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-action" ], "dependencyGraph": { "calcite-tip": [ "calcite-action" ], "calcite-action": [ "calcite-loader", "calcite-icon" ] } }, { "filePath": "./src/components/tip-group/tip-group.tsx", "encapsulation": "shadow", "tag": "calcite-tip-group", "readme": "# calcite-tip-group\n\n`calcite-tip-group` is a wrapper for multiple `calcite-tip`s and is housed in `calcite-tip-manager`.\n", "docs": "`calcite-tip-group` is a wrapper for multiple `calcite-tip`s and is housed in `calcite-tip-manager`.", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-tip`s." } ], "usage": {}, "props": [ { "name": "groupTitle", "type": "string", "mutable": false, "attr": "group-title", "reflectToAttr": false, "docs": "The component header text for all nested `calcite-tip`s.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-tip`s." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/tip-manager/tip-manager.tsx", "encapsulation": "shadow", "tag": "calcite-tip-manager", "readme": "# calcite-tip-manager\n\nThe `calcite-tip-manager` component contains multiple `calcite-tip`s that a user can view through via interactive arrows to go back and forth through the tips in the deck.\n", "docs": "The `calcite-tip-manager` component contains multiple `calcite-tip`s that a user can view through via interactive arrows to go back and forth through the tips in the deck.", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-tip`s." } ], "usage": { "Basic": "Renders a tip manager using a group of tips as well as a single tip.\n\n```html\n\n \n \n \"This\n

\n Tip description lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut\n labore et dolore magna aliqua.\n

\n

\n This is another slotted paragraph. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut\n aliquip ex ea commodo consequat.\n

\n A calcite-link\n
\n \n
\n \n \n
\n```\n" }, "props": [ { "name": "closed", "type": "boolean", "mutable": true, "attr": "closed", "reflectToAttr": true, "docs": "When `true`, does not display or position the component.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "headingLevel", "type": "1 | 2 | 3 | 4 | 5 | 6", "mutable": false, "attr": "heading-level", "reflectToAttr": true, "docs": "Specifies the number at which section headings should start.", "docsTags": [], "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "optional": false, "required": false }, { "name": "intlClose", "type": "string", "mutable": false, "attr": "intl-close", "reflectToAttr": false, "docs": "Accessible name for the component's close button.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlDefaultTitle", "type": "string", "mutable": false, "attr": "intl-default-title", "reflectToAttr": false, "docs": "Accessible name for the `calcite-tip-group` title.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlNext", "type": "string", "mutable": false, "attr": "intl-next", "reflectToAttr": false, "docs": "Accessible name for navigating to the next tip.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlPaginationLabel", "type": "string", "mutable": false, "attr": "intl-pagination-label", "reflectToAttr": false, "docs": "Text that accompanies the component's pagination.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlPrevious", "type": "string", "mutable": false, "attr": "intl-previous", "reflectToAttr": false, "docs": "Accessible name for navigating to the previous tip.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [ { "name": "nextTip", "returns": { "type": "Promise", "docs": "" }, "signature": "nextTip() => Promise", "parameters": [], "docs": "Selects the next `calcite-tip` to display.", "docsTags": [] }, { "name": "previousTip", "returns": { "type": "Promise", "docs": "" }, "signature": "previousTip() => Promise", "parameters": [], "docs": "Selects the previous `calcite-tip` to display.", "docsTags": [] } ], "events": [ { "event": "calciteTipManagerClose", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the component has been closed.", "docsTags": [] }, { "event": "calciteTipManagerToggle", "detail": "void", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the component has been open or closed.", "docsTags": [ { "name": "deprecated", "text": "use `calciteTipManagerClose` instead." } ], "deprecation": "use `calciteTipManagerClose` instead." } ], "listeners": [], "styles": [ { "name": "--calcite-tip-manager-height", "annotation": "prop", "docs": "The maximum height of the component." }, { "name": "--calcite-tip-max-width", "annotation": "prop", "docs": "The maximum width of a slotted `calcite-tip` within the component." } ], "slots": [ { "name": "", "docs": "A slot for adding `calcite-tip`s." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-action", "calcite-icon" ], "dependencyGraph": { "calcite-tip-manager": [ "calcite-action", "calcite-icon" ], "calcite-action": [ "calcite-loader", "calcite-icon" ] } }, { "filePath": "./src/components/tooltip/tooltip.tsx", "encapsulation": "shadow", "tag": "calcite-tooltip", "readme": "# calcite-tooltip\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding text." } ], "usage": { "Basic": "```html\nThis is the message of the tooltip\n

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

\n```\n", "Virtual": "```html\n\nThis is the message of the tooltip\n\n\n```\n" }, "props": [ { "name": "closeOnClick", "type": "boolean", "mutable": false, "attr": "close-on-click", "reflectToAttr": true, "docs": "Closes the component when the `referenceElement` is clicked.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": false, "docs": "Accessible name for the component.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "offsetDistance", "type": "number", "mutable": false, "attr": "offset-distance", "reflectToAttr": true, "docs": "Offset the position of the component away from the `referenceElement`.", "docsTags": [ { "name": "default", "text": "6" } ], "default": "defaultOffsetDistance", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "offsetSkidding", "type": "number", "mutable": false, "attr": "offset-skidding", "reflectToAttr": true, "docs": "Offset the position of the component along the `referenceElement`.", "docsTags": [], "default": "0", "values": [ { "type": "number" } ], "optional": false, "required": false }, { "name": "open", "type": "boolean", "mutable": false, "attr": "open", "reflectToAttr": true, "docs": "When `true`, the component is open.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "overlayPositioning", "type": "\"absolute\" | \"fixed\"", "mutable": false, "attr": "overlay-positioning", "reflectToAttr": true, "docs": "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\nThe `\"fixed\"` value should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `\"fixed\"`.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "type": "string" } ], "optional": false, "required": false }, { "name": "placement", "type": "Placement | VariationPlacement | AutoPlacement | DeprecatedPlacement", "mutable": false, "attr": "placement", "reflectToAttr": true, "docs": "Determines where the component will be positioned relative to the `referenceElement`.", "docsTags": [ { "name": "see", "text": "[LogicalPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/floating-ui.ts#L25)" } ], "default": "\"auto\"", "values": [ { "type": "Placement" }, { "type": "VariationPlacement" }, { "type": "AutoPlacement" }, { "type": "DeprecatedPlacement" } ], "optional": false, "required": false }, { "name": "referenceElement", "type": "Element | VirtualElement | string", "mutable": false, "attr": "reference-element", "reflectToAttr": false, "docs": "The `referenceElement` to position the component according to its `\"placement\"` value.\n\nSetting to the `HTMLElement` is preferred so the component does not need to query the DOM for the `referenceElement`.\n\nHowever, a string ID of the reference element can be used.", "docsTags": [], "values": [ { "type": "Element" }, { "type": "VirtualElement" }, { "type": "string" } ], "optional": false, "required": false } ], "methods": [ { "name": "reposition", "returns": { "type": "Promise", "docs": "" }, "signature": "reposition(delayed?: boolean) => Promise", "parameters": [], "docs": "Updates the position of the component.", "docsTags": [ { "name": "param", "text": "delayed" } ] } ], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding text." } ], "parts": [], "dependents": [ "calcite-flow-item" ], "dependencies": [], "dependencyGraph": { "calcite-flow-item": [ "calcite-tooltip" ] } }, { "filePath": "./src/components/tooltip-manager/tooltip-manager.tsx", "encapsulation": "shadow", "tag": "calcite-tooltip-manager", "readme": "# calcite-tooltip-manager\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for adding elements that reference a `calcite-tooltip` by the `selector` property." }, { "name": "deprecated", "text": "No longer required for tooltip usage." } ], "usage": {}, "props": [ { "name": "selector", "type": "string", "mutable": false, "attr": "selector", "reflectToAttr": true, "docs": "CSS Selector to match reference elements for tooltips. Reference elements will be identified by this selector in order to open their associated tooltip.", "docsTags": [ { "name": "default", "text": "`[data-calcite-tooltip-reference]`" } ], "default": "\"[data-calcite-tooltip-reference]\"", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding elements that reference a `calcite-tooltip` by the `selector` property." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {}, "deprecation": "No longer required for tooltip usage." }, { "filePath": "./src/components/tree/tree.tsx", "encapsulation": "shadow", "tag": "calcite-tree", "readme": "# calcite-tree\n", "docs": "", "docsTags": [ { "name": "slot", "text": "- A slot for `calcite-tree-item` elements." } ], "usage": { "Basic": "`` can be used as a sidebar navigation tree with optional lines and different selection modes.\n\n```html\n\n \n Child 1\n \n \n Grandchild 1\n \n \n Grandchild 2\n \n \n \n\n```\n" }, "props": [ { "name": "inputEnabled", "type": "boolean", "mutable": false, "attr": "input-enabled", "reflectToAttr": false, "docs": "Display input", "docsTags": [ { "name": "deprecated", "text": "Use `selectionMode=\"ancestors\"` for checkbox input." } ], "default": "false", "deprecation": "Use `selectionMode=\"ancestors\"` for checkbox input.", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "lines", "type": "boolean", "mutable": true, "attr": "lines", "reflectToAttr": true, "docs": "Displays indentation guide lines.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "scale", "type": "\"l\" | \"m\" | \"s\"", "mutable": true, "attr": "scale", "reflectToAttr": true, "docs": "Specifies the size of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": false, "required": false }, { "name": "selectionMode", "type": "TreeSelectionMode.Ancestors | TreeSelectionMode.Children | TreeSelectionMode.Multi | TreeSelectionMode.MultiChildren | TreeSelectionMode.None | TreeSelectionMode.Single", "mutable": true, "attr": "selection-mode", "reflectToAttr": true, "docs": "Customize how the component's selection works.", "docsTags": [ { "name": "default", "text": "\"single\"" }, { "name": "see", "text": "[TreeSelectionMode](https://github.com/Esri/calcite-components/blob/master/src/components/tree/interfaces.ts#L5)" } ], "default": "TreeSelectionMode.Single", "values": [ { "type": "TreeSelectionMode.Ancestors" }, { "type": "TreeSelectionMode.Children" }, { "type": "TreeSelectionMode.Multi" }, { "type": "TreeSelectionMode.MultiChildren" }, { "type": "TreeSelectionMode.None" }, { "type": "TreeSelectionMode.Single" } ], "optional": false, "required": false } ], "methods": [], "events": [ { "event": "calciteTreeSelect", "detail": "TreeSelectDetail", "bubbles": true, "cancelable": false, "composed": true, "docs": "Fires when the user selects/deselects `calcite-tree-items`. An object including an array of selected items will be passed in the event's `detail` property.", "docsTags": [ { "name": "see", "text": "[TreeSelectDetail](https://github.com/Esri/calcite-components/blob/master/src/components/tree/interfaces.ts#L1)" } ] } ], "listeners": [ { "event": "focus", "capture": false, "passive": false }, { "event": "focusin", "capture": false, "passive": false }, { "event": "focusout", "capture": false, "passive": false }, { "event": "calciteInternalTreeItemSelect", "capture": false, "passive": false }, { "event": "keydown", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for `calcite-tree-item` elements." } ], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "./src/components/tree-item/tree-item.tsx", "encapsulation": "shadow", "tag": "calcite-tree-item", "readme": "# calcite-tree-item\n\n`` is used to represent a single item in a ``.\n", "docs": "`` is used to represent a single item in a ``.", "docsTags": [ { "name": "slot", "text": "- A slot for adding the component's content." }, { "name": "slot", "text": "children - A slot for adding nested `calcite-tree` elements." } ], "usage": {}, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "expanded", "type": "boolean", "mutable": true, "attr": "expanded", "reflectToAttr": true, "docs": "When `true`, the component is expanded.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "selected", "type": "boolean", "mutable": true, "attr": "selected", "reflectToAttr": true, "docs": "When `true`, the component is selected.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [ { "event": "click", "capture": false, "passive": false }, { "event": "keydown", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding the component's content." }, { "name": "children", "docs": "A slot for adding nested `calcite-tree` elements." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-icon", "calcite-checkbox" ], "dependencyGraph": { "calcite-tree-item": [ "calcite-icon", "calcite-checkbox" ] } }, { "filePath": "./src/components/value-list/value-list.tsx", "encapsulation": "shadow", "tag": "calcite-value-list", "readme": "# calcite-value-list\n\n`calcite-value-list` is housed in a panel and contains `calcite-value-list-item`s. The value list has options for drag and drop, label editing, and single or multi-select of items which can be done through shift+click.\n", "docs": "`calcite-value-list` is housed in a panel and contains `calcite-value-list-item`s. The value list has options for drag and drop, label editing, and single or multi-select of items which can be done through shift+click.", "docsTags": [ { "name": "slot", "text": "- A slot for adding `calcite-value-list-item` elements. List items are displayed as a vertical list." }, { "name": "slot", "text": "menu-actions - A slot for adding a button and menu combination for performing actions, such as sorting." } ], "usage": { "Basic": "Renders a value list with multiple items able to be selected and a filter.\n\n```html\n\n \n \n \n \n \n \n \n \n \n\n```\n", "Drag-and-drop": "Renders a value list with drag and drop capability between the items.\n\n```html\n\n \n \n \n \n \n\n```\n" }, "props": [ { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "dragEnabled", "type": "boolean", "mutable": false, "attr": "drag-enabled", "reflectToAttr": true, "docs": "When `true`, `calcite-value-list-item`s are sortable via a draggable button.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "filterEnabled", "type": "boolean", "mutable": false, "attr": "filter-enabled", "reflectToAttr": true, "docs": "When `true`, an input appears at the top of the component that can be used by end users to filter list items.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "filterPlaceholder", "type": "string", "mutable": false, "attr": "filter-placeholder", "reflectToAttr": true, "docs": "Placeholder text for the filter's input field.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "group", "type": "string", "mutable": false, "attr": "group", "reflectToAttr": true, "docs": "The component's group identifier.\n\nTo drag elements from one list into another, both lists must have the same group value.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlDragHandleActive", "type": "string", "mutable": false, "attr": "intl-drag-handle-active", "reflectToAttr": false, "docs": "When `dragEnabled` is `true` and active, specifies accessible context to the component.\n\nUse \"`${position}` of `${total}`\" as a placeholder for displaying indices and `${item.label}` as a placeholder for displaying the `calcite-value-list-item` label.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlDragHandleChange", "type": "string", "mutable": false, "attr": "intl-drag-handle-change", "reflectToAttr": false, "docs": "When `dragEnabled` is `true` and active, specifies accessible context to the `calcite-value-list-item`s new position.\n\nUse \"`${position}` of `${total}`\" as a placeholder for displaying indices and `${item.label}` as a placeholder for displaying the `calcite-value-list-item` label.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlDragHandleCommit", "type": "string", "mutable": false, "attr": "intl-drag-handle-commit", "reflectToAttr": false, "docs": "When `dragEnabled` is `true` and active, specifies accessible context to the `calcite-value-list-item`s current position after commit.\n\nUse \"`${position}` of `${total}`\" as a placeholder for displaying indices and `${item.label}` as a placeholder for displaying the `calcite-value-list-item` label.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "intlDragHandleIdle", "type": "string", "mutable": false, "attr": "intl-drag-handle-idle", "reflectToAttr": false, "docs": "When `dragEnabled` is `true` and active, specifies accessible context to the `calcite-value-list-item`s initial position.\n\nUse \"`${position}` of `${total}`\" as a placeholder for displaying indices and `${item.label}` as a placeholder for displaying the `calcite-value-list-item` label.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "loading", "type": "boolean", "mutable": false, "attr": "loading", "reflectToAttr": true, "docs": "When `true`, a busy indicator is displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "multiple", "type": "boolean", "mutable": false, "attr": "multiple", "reflectToAttr": true, "docs": "Similar to standard radio buttons and checkboxes.\nWhen `true`, a user can select multiple `calcite-value-list-item`s at a time.\nWhen `false`, only a single `calcite-value-list-item` can be selected at a time,\nand a new selection will deselect previous selections.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "selectionFollowsFocus", "type": "boolean", "mutable": false, "attr": "selection-follows-focus", "reflectToAttr": true, "docs": "When `true` and single-selection is enabled, the selection changes when navigating `calcite-value-list-item`s via keyboard.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false } ], "methods": [ { "name": "getSelectedItems", "returns": { "type": "Promise>", "docs": "" }, "signature": "getSelectedItems() => Promise>", "parameters": [], "docs": "Returns the currently selected items", "docsTags": [] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus(focusId?: ListFocusId) => Promise", "parameters": [], "docs": "Sets focus on the component.", "docsTags": [ { "name": "param", "text": "focusId" } ] } ], "events": [ { "event": "calciteListChange", "detail": "Map", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when any of the list item selections have changed.", "docsTags": [] }, { "event": "calciteListOrderChange", "detail": "any[]", "bubbles": true, "cancelable": false, "composed": true, "docs": "Emits when the order of the list has changed.", "docsTags": [] } ], "listeners": [ { "event": "focusout", "capture": false, "passive": false }, { "event": "calciteListItemRemove", "capture": false, "passive": false }, { "event": "calciteListItemChange", "capture": false, "passive": false }, { "event": "calciteInternalListItemPropsChange", "capture": false, "passive": false }, { "event": "calciteInternalListItemValueChange", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "", "docs": "A slot for adding `calcite-value-list-item` elements. List items are displayed as a vertical list." }, { "name": "menu-actions", "docs": "A slot for adding a button and menu combination for performing actions, such as sorting." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-filter", "calcite-scrim" ], "dependencyGraph": { "calcite-value-list": [ "calcite-filter", "calcite-scrim" ], "calcite-filter": [ "calcite-input" ], "calcite-input": [ "calcite-progress", "calcite-icon" ], "calcite-scrim": [ "calcite-loader" ] } }, { "filePath": "./src/components/value-list-item/value-list-item.tsx", "encapsulation": "shadow", "tag": "calcite-value-list-item", "readme": "# calcite-value-list-item\n\n`calcite-value-list-item`s are cards contained in a `calcite-value-list`. They each can have a label and description, an icon and can have their label's be editable (inherited from `calcite-value-list`). The developer can disable or preselect each list item and give it a value.\n", "docs": "`calcite-value-list-item`s are cards contained in a `calcite-value-list`. They each can have a label and description, an icon and can have their label's be editable (inherited from `calcite-value-list`). The developer can disable or preselect each list item and give it a value.", "docsTags": [ { "name": "slot", "text": "actions-end - A slot for adding actions or content to the end side of the component." }, { "name": "slot", "text": "actions-start - A slot for adding actions or content to the start side of the component." } ], "usage": {}, "props": [ { "name": "description", "type": "string", "mutable": false, "attr": "description", "reflectToAttr": true, "docs": "A description for the component that displays below the label text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "disabled", "type": "boolean", "mutable": false, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, interaction is prevented and the component is displayed with lower opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "icon", "type": "ICON_TYPES.circle | ICON_TYPES.grip | ICON_TYPES.square", "mutable": false, "attr": "icon", "reflectToAttr": true, "docs": "Determines the icon SVG symbol that will be shown. Options are circle, square, grip or null.", "docsTags": [ { "name": "see", "text": "[ICON_TYPES](https://github.com/Esri/calcite-components/blob/master/src/components/pick-list/resources.ts#L5)" } ], "default": "null", "values": [ { "type": "ICON_TYPES.circle" }, { "type": "ICON_TYPES.grip" }, { "type": "ICON_TYPES.square" } ], "optional": true, "required": false }, { "name": "label", "type": "string", "mutable": false, "attr": "label", "reflectToAttr": true, "docs": "Label and accessible name for the component. Appears next to the icon.", "docsTags": [], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "metadata", "type": "{ [x: string]: unknown; }", "mutable": false, "reflectToAttr": false, "docs": "Provides additional metadata to the component. Primary use is for a filter on the parent list.", "docsTags": [], "values": [ { "type": "{ [x: string]: unknown; }" } ], "optional": true, "required": false }, { "name": "nonInteractive", "type": "boolean", "mutable": false, "attr": "non-interactive", "reflectToAttr": true, "docs": "When `true`, prevents the content of the component from user interaction.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "removable", "type": "boolean", "mutable": false, "attr": "removable", "reflectToAttr": true, "docs": "When `true`, adds an action to remove the component.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "selected", "type": "boolean", "mutable": true, "attr": "selected", "reflectToAttr": true, "docs": "When `true`, the component is selected.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "any", "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The component's value.", "docsTags": [], "values": [ { "type": "any" } ], "optional": false, "required": true } ], "methods": [ { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "signature": "setFocus() => Promise", "parameters": [], "docs": "Set focus on the component.", "docsTags": [] }, { "name": "toggleSelected", "returns": { "type": "Promise", "docs": "" }, "signature": "toggleSelected(coerce?: boolean) => Promise", "parameters": [], "docs": "Toggle the selection state. By default this won't trigger an event.\nThe first argument allows the value to be coerced, rather than swapping values.", "docsTags": [ { "name": "param", "text": "coerce" } ] } ], "events": [ { "event": "calciteListItemRemove", "detail": "void", "bubbles": true, "cancelable": true, "composed": true, "docs": "Fires when the remove button is pressed.", "docsTags": [] } ], "listeners": [ { "event": "calciteListItemChange", "capture": false, "passive": false } ], "styles": [], "slots": [ { "name": "actions-end", "docs": "A slot for adding actions or content to the end side of the component." }, { "name": "actions-start", "docs": "A slot for adding actions or content to the start side of the component." } ], "parts": [], "dependents": [], "dependencies": [ "calcite-icon", "calcite-pick-list-item" ], "dependencyGraph": { "calcite-value-list-item": [ "calcite-icon", "calcite-pick-list-item" ], "calcite-pick-list-item": [ "calcite-icon", "calcite-action" ], "calcite-action": [ "calcite-loader", "calcite-icon" ] } } ] }