From 90757f96fa40b3c68988429523880b6f2c2f8b37 Mon Sep 17 00:00:00 2001 From: benelan <10986395+benelan@users.noreply.github.com> Date: Mon, 15 Jul 2024 00:23:25 +0000 Subject: [PATCH] docs: update component READMEs --- .../calcite-components/src/components.d.ts | 98 -------- .../src/components/accordion-item/readme.md | 16 +- .../src/components/accordion/readme.md | 12 - .../src/components/action-bar/readme.md | 53 ----- .../src/components/action-menu/readme.md | 2 +- .../src/components/action-pad/readme.md | 39 ---- .../src/components/action/readme.md | 68 ++---- .../src/components/alert/readme.md | 16 +- .../src/components/avatar/readme.md | 32 --- .../src/components/block-section/readme.md | 20 +- .../src/components/block/readme.md | 92 ++------ .../src/components/button/readme.md | 103 ++------- .../src/components/card-group/readme.md | 48 ---- .../src/components/card/readme.md | 15 -- .../src/components/checkbox/readme.md | 24 -- .../src/components/chip-group/readme.md | 24 -- .../src/components/chip/readme.md | 36 ++- .../src/components/color-picker/readme.md | 8 - .../src/components/combobox-item/readme.md | 24 +- .../src/components/combobox/readme.md | 126 +++-------- .../src/components/date-picker/readme.md | 22 -- .../src/components/dropdown-item/readme.md | 22 +- .../src/components/dropdown/readme.md | 56 ----- .../src/components/fab/readme.md | 58 +---- .../src/components/flow-item/readme.md | 1 + .../src/components/flow/readme.md | 92 -------- .../src/components/icon/readme.md | 28 +-- .../src/components/inline-editable/readme.md | 33 --- .../components/input-date-picker/readme.md | 27 +-- .../src/components/input-message/readme.md | 17 +- .../src/components/input-number/readme.md | 23 +- .../src/components/input-text/readme.md | 12 +- .../components/input-time-picker/readme.md | 18 +- .../src/components/input-time-zone/readme.md | 20 +- .../src/components/input/readme.md | 71 +----- .../src/components/label/readme.md | 28 --- .../src/components/link/readme.md | 42 +--- .../src/components/list/readme.md | 210 ------------------ .../src/components/loader/readme.md | 26 --- .../src/components/menu-item/readme.md | 28 +-- .../src/components/meter/readme.md | 29 --- .../src/components/modal/readme.md | 44 ---- .../src/components/navigation-logo/readme.md | 34 ++- .../src/components/navigation-user/readme.md | 8 - .../src/components/navigation/readme.md | 16 -- .../src/components/notice/readme.md | 23 +- .../src/components/pagination/readme.md | 21 -- .../src/components/panel/readme.md | 112 +--------- .../src/components/pick-list/readme.md | 63 ------ .../src/components/popover/readme.md | 41 +--- .../src/components/progress/readme.md | 8 - .../components/radio-button-group/readme.md | 73 +----- .../src/components/radio-button/readme.md | 11 - .../src/components/rating/readme.md | 8 - .../src/components/scrim/readme.md | 71 ------ .../segmented-control-item/readme.md | 14 +- .../components/segmented-control/readme.md | 15 +- .../src/components/select/readme.md | 109 +-------- .../src/components/sheet/readme.md | 66 ------ .../src/components/shell-panel/readme.md | 72 ------ .../src/components/shell/readme.md | 168 -------------- .../src/components/slider/readme.md | 24 -- .../src/components/split-button/readme.md | 50 ++--- .../src/components/stack/readme.md | 26 --- .../src/components/stepper/readme.md | 39 ---- .../src/components/switch/readme.md | 12 - .../src/components/tab-nav/readme.md | 16 -- .../src/components/tab-title/readme.md | 22 +- .../src/components/tab/readme.md | 10 - .../src/components/table/readme.md | 108 --------- .../src/components/tabs/readme.md | 34 --- .../src/components/text-area/readme.md | 18 +- .../components/tile-select-group/readme.md | 37 --- .../src/components/tile-select/readme.md | 45 ++-- .../src/components/tile/readme.md | 41 ++-- .../src/components/time-picker/readme.md | 8 - .../src/components/tip-manager/readme.md | 46 ---- .../src/components/tip/readme.md | 16 -- .../src/components/tooltip/readme.md | 45 +--- .../src/components/tree-item/readme.md | 14 +- .../src/components/tree/readme.md | 38 ---- .../src/components/value-list/readme.md | 38 ---- 82 files changed, 287 insertions(+), 3096 deletions(-) diff --git a/packages/calcite-components/src/components.d.ts b/packages/calcite-components/src/components.d.ts index 47f36825dfd..6cd33f7dc66 100644 --- a/packages/calcite-components/src/components.d.ts +++ b/packages/calcite-components/src/components.d.ts @@ -9,185 +9,87 @@ import { Alignment, Appearance, CollapseDirection, FlipContext, IconType, Kind, import { RequestedItem } from "./components/accordion/interfaces"; import { IconName } from "./components/icon/interfaces"; import { RequestedItem as RequestedItem1 } from "./components/accordion-item/interfaces"; -import { ActionMessages } from "./components/action/assets/action/t9n"; import { FlipPlacement, LogicalPlacement, MenuPlacement, OverlayPositioning, ReferenceElement } from "./utils/floating-ui"; -import { ActionBarMessages } from "./components/action-bar/assets/action-bar/t9n"; import { Columns } from "./components/action-group/interfaces"; -import { ActionGroupMessages } from "./components/action-group/assets/action-group/t9n"; -import { ActionPadMessages } from "./components/action-pad/assets/action-pad/t9n"; import { AlertDuration, Sync } from "./components/alert/interfaces"; import { NumberingSystem } from "./utils/locale"; -import { AlertMessages } from "./components/alert/assets/alert/t9n"; import { HeadingLevel } from "./components/functional/Heading"; -import { BlockMessages } from "./components/block/assets/block/t9n"; import { BlockSectionToggleDisplay } from "./components/block-section/interfaces"; -import { BlockSectionMessages } from "./components/block-section/assets/block-section/t9n"; import { ButtonAlignment, DropdownIconType } from "./components/button/interfaces"; -import { ButtonMessages } from "./components/button/assets/button/t9n"; -import { CardMessages } from "./components/card/assets/card/t9n"; import { ArrowType, AutoplayType } from "./components/carousel/interfaces"; -import { CarouselMessages } from "./components/carousel/assets/carousel/t9n"; import { MutableValidityState } from "./utils/form"; -import { ChipMessages } from "./components/chip/assets/chip/t9n"; import { ColorValue, InternalColor } from "./components/color-picker/interfaces"; import { Format } from "./components/color-picker/utils"; -import { ColorPickerMessages } from "./components/color-picker/assets/color-picker/t9n"; import { ComboboxChildElement, SelectionDisplay } from "./components/combobox/interfaces"; -import { ComboboxMessages } from "./components/combobox/assets/combobox/t9n"; -import { DatePickerMessages } from "./components/date-picker/assets/date-picker/t9n"; import { DateLocaleData } from "./components/date-picker/utils"; import { HoverRange } from "./utils/date"; import { RequestedItem as RequestedItem2 } from "./components/dropdown-group/interfaces"; import { ItemKeyboardEvent } from "./components/dropdown/interfaces"; -import { FilterMessages } from "./components/filter/assets/filter/t9n"; import { FlowItemLikeElement } from "./components/flow/interfaces"; -import { FlowItemMessages } from "./components/flow-item/assets/flow-item/t9n"; import { ColorStop, DataSeries } from "./components/graph/interfaces"; -import { HandleMessages } from "./components/handle/assets/handle/t9n"; import { HandleChange, HandleNudge } from "./components/handle/interfaces"; -import { InlineEditableMessages } from "./components/inline-editable/assets/inline-editable/t9n"; import { InputPlacement } from "./components/input/interfaces"; -import { InputMessages } from "./components/input/assets/input/t9n"; -import { InputDatePickerMessages } from "./components/input-date-picker/assets/input-date-picker/t9n"; -import { InputNumberMessages } from "./components/input-number/assets/input-number/t9n"; -import { InputTextMessages } from "./components/input-text/assets/input-text/t9n"; -import { InputTimePickerMessages } from "./components/input-time-picker/assets/input-time-picker/t9n"; -import { TimePickerMessages } from "./components/time-picker/assets/time-picker/t9n"; -import { InputTimeZoneMessages } from "./components/input-time-zone/assets/input-time-zone/t9n"; import { OffsetStyle, TimeZoneMode } from "./components/input-time-zone/interfaces"; import { ListDragDetail } from "./components/list/interfaces"; import { ItemData } from "./components/list-item/interfaces"; -import { ListMessages } from "./components/list/assets/list/t9n"; import { SelectionAppearance } from "./components/list/resources"; -import { ListItemMessages } from "./components/list-item/assets/list-item/t9n"; -import { MenuMessages } from "./components/menu/assets/menu/t9n"; -import { MenuItemMessages } from "./components/menu-item/assets/menu-item/t9n"; import { MenuItemCustomEvent } from "./components/menu-item/interfaces"; import { MeterFillType, MeterLabelType } from "./components/meter/interfaces"; -import { ModalMessages } from "./components/modal/assets/modal/t9n"; -import { NoticeMessages } from "./components/notice/assets/notice/t9n"; -import { PaginationMessages } from "./components/pagination/assets/pagination/t9n"; -import { PanelMessages } from "./components/panel/assets/panel/t9n"; import { ItemData as ItemData1, ListFocusId } from "./components/pick-list/shared-list-logic"; import { ICON_TYPES } from "./components/pick-list/resources"; -import { PickListItemMessages } from "./components/pick-list-item/assets/pick-list-item/t9n"; -import { PopoverMessages } from "./components/popover/assets/popover/t9n"; -import { RatingMessages } from "./components/rating/assets/rating/t9n"; -import { ScrimMessages } from "./components/scrim/assets/scrim/t9n"; import { DisplayMode } from "./components/sheet/interfaces"; import { DisplayMode as DisplayMode1 } from "./components/shell-panel/interfaces"; -import { ShellPanelMessages } from "./components/shell-panel/assets/shell-panel/t9n"; import { DragDetail } from "./utils/sortableComponent"; import { StepperItemChangeEventDetail, StepperItemEventDetail, StepperItemKeyEventDetail, StepperLayout } from "./components/stepper/interfaces"; -import { StepperMessages } from "./components/stepper/assets/stepper/t9n"; -import { StepperItemMessages } from "./components/stepper-item/assets/stepper-item/t9n"; import { TabID, TabLayout, TabPosition } from "./components/tabs/interfaces"; -import { TabNavMessages } from "./components/tab-nav/assets/tab-nav/t9n"; import { TabChangeEventDetail, TabCloseEventDetail } from "./components/tab/interfaces"; -import { TabTitleMessages } from "./components/tab-title/assets/tab-title/t9n"; import { RowType, TableInteractionMode, TableLayout, TableRowFocusEvent, TableSelectionDisplay } from "./components/table/interfaces"; -import { TableMessages } from "./components/table/assets/table/t9n"; -import { TableCellMessages } from "./components/table-cell/assets/table-cell/t9n"; -import { TableHeaderMessages } from "./components/table-header/assets/table-header/t9n"; -import { TextAreaMessages } from "./components/text-area/assets/text-area/t9n"; import { TileSelectType } from "./components/tile-select/interfaces"; import { TileSelectGroupLayout } from "./components/tile-select-group/interfaces"; -import { TipMessages } from "./components/tip/assets/tip/t9n"; -import { TipManagerMessages } from "./components/tip-manager/assets/tip-manager/t9n"; import { TreeItemSelectDetail } from "./components/tree-item/interfaces"; -import { ValueListMessages } from "./components/value-list/assets/value-list/t9n"; import { ListItemAndHandle } from "./components/value-list-item/interfaces"; export { Alignment, Appearance, CollapseDirection, FlipContext, IconType, Kind, Layout, LogicalFlowPosition, Position, Scale, SelectionAppearance as SelectionAppearance1, SelectionMode, Status, Width } from "./components/interfaces"; export { RequestedItem } from "./components/accordion/interfaces"; export { IconName } from "./components/icon/interfaces"; export { RequestedItem as RequestedItem1 } from "./components/accordion-item/interfaces"; -export { ActionMessages } from "./components/action/assets/action/t9n"; export { FlipPlacement, LogicalPlacement, MenuPlacement, OverlayPositioning, ReferenceElement } from "./utils/floating-ui"; -export { ActionBarMessages } from "./components/action-bar/assets/action-bar/t9n"; export { Columns } from "./components/action-group/interfaces"; -export { ActionGroupMessages } from "./components/action-group/assets/action-group/t9n"; -export { ActionPadMessages } from "./components/action-pad/assets/action-pad/t9n"; export { AlertDuration, Sync } from "./components/alert/interfaces"; export { NumberingSystem } from "./utils/locale"; -export { AlertMessages } from "./components/alert/assets/alert/t9n"; export { HeadingLevel } from "./components/functional/Heading"; -export { BlockMessages } from "./components/block/assets/block/t9n"; export { BlockSectionToggleDisplay } from "./components/block-section/interfaces"; -export { BlockSectionMessages } from "./components/block-section/assets/block-section/t9n"; export { ButtonAlignment, DropdownIconType } from "./components/button/interfaces"; -export { ButtonMessages } from "./components/button/assets/button/t9n"; -export { CardMessages } from "./components/card/assets/card/t9n"; export { ArrowType, AutoplayType } from "./components/carousel/interfaces"; -export { CarouselMessages } from "./components/carousel/assets/carousel/t9n"; export { MutableValidityState } from "./utils/form"; -export { ChipMessages } from "./components/chip/assets/chip/t9n"; export { ColorValue, InternalColor } from "./components/color-picker/interfaces"; export { Format } from "./components/color-picker/utils"; -export { ColorPickerMessages } from "./components/color-picker/assets/color-picker/t9n"; export { ComboboxChildElement, SelectionDisplay } from "./components/combobox/interfaces"; -export { ComboboxMessages } from "./components/combobox/assets/combobox/t9n"; -export { DatePickerMessages } from "./components/date-picker/assets/date-picker/t9n"; export { DateLocaleData } from "./components/date-picker/utils"; export { HoverRange } from "./utils/date"; export { RequestedItem as RequestedItem2 } from "./components/dropdown-group/interfaces"; export { ItemKeyboardEvent } from "./components/dropdown/interfaces"; -export { FilterMessages } from "./components/filter/assets/filter/t9n"; export { FlowItemLikeElement } from "./components/flow/interfaces"; -export { FlowItemMessages } from "./components/flow-item/assets/flow-item/t9n"; export { ColorStop, DataSeries } from "./components/graph/interfaces"; -export { HandleMessages } from "./components/handle/assets/handle/t9n"; export { HandleChange, HandleNudge } from "./components/handle/interfaces"; -export { InlineEditableMessages } from "./components/inline-editable/assets/inline-editable/t9n"; export { InputPlacement } from "./components/input/interfaces"; -export { InputMessages } from "./components/input/assets/input/t9n"; -export { InputDatePickerMessages } from "./components/input-date-picker/assets/input-date-picker/t9n"; -export { InputNumberMessages } from "./components/input-number/assets/input-number/t9n"; -export { InputTextMessages } from "./components/input-text/assets/input-text/t9n"; -export { InputTimePickerMessages } from "./components/input-time-picker/assets/input-time-picker/t9n"; -export { TimePickerMessages } from "./components/time-picker/assets/time-picker/t9n"; -export { InputTimeZoneMessages } from "./components/input-time-zone/assets/input-time-zone/t9n"; export { OffsetStyle, TimeZoneMode } from "./components/input-time-zone/interfaces"; export { ListDragDetail } from "./components/list/interfaces"; export { ItemData } from "./components/list-item/interfaces"; -export { ListMessages } from "./components/list/assets/list/t9n"; export { SelectionAppearance } from "./components/list/resources"; -export { ListItemMessages } from "./components/list-item/assets/list-item/t9n"; -export { MenuMessages } from "./components/menu/assets/menu/t9n"; -export { MenuItemMessages } from "./components/menu-item/assets/menu-item/t9n"; export { MenuItemCustomEvent } from "./components/menu-item/interfaces"; export { MeterFillType, MeterLabelType } from "./components/meter/interfaces"; -export { ModalMessages } from "./components/modal/assets/modal/t9n"; -export { NoticeMessages } from "./components/notice/assets/notice/t9n"; -export { PaginationMessages } from "./components/pagination/assets/pagination/t9n"; -export { PanelMessages } from "./components/panel/assets/panel/t9n"; export { ItemData as ItemData1, ListFocusId } from "./components/pick-list/shared-list-logic"; export { ICON_TYPES } from "./components/pick-list/resources"; -export { PickListItemMessages } from "./components/pick-list-item/assets/pick-list-item/t9n"; -export { PopoverMessages } from "./components/popover/assets/popover/t9n"; -export { RatingMessages } from "./components/rating/assets/rating/t9n"; -export { ScrimMessages } from "./components/scrim/assets/scrim/t9n"; export { DisplayMode } from "./components/sheet/interfaces"; export { DisplayMode as DisplayMode1 } from "./components/shell-panel/interfaces"; -export { ShellPanelMessages } from "./components/shell-panel/assets/shell-panel/t9n"; export { DragDetail } from "./utils/sortableComponent"; export { StepperItemChangeEventDetail, StepperItemEventDetail, StepperItemKeyEventDetail, StepperLayout } from "./components/stepper/interfaces"; -export { StepperMessages } from "./components/stepper/assets/stepper/t9n"; -export { StepperItemMessages } from "./components/stepper-item/assets/stepper-item/t9n"; export { TabID, TabLayout, TabPosition } from "./components/tabs/interfaces"; -export { TabNavMessages } from "./components/tab-nav/assets/tab-nav/t9n"; export { TabChangeEventDetail, TabCloseEventDetail } from "./components/tab/interfaces"; -export { TabTitleMessages } from "./components/tab-title/assets/tab-title/t9n"; export { RowType, TableInteractionMode, TableLayout, TableRowFocusEvent, TableSelectionDisplay } from "./components/table/interfaces"; -export { TableMessages } from "./components/table/assets/table/t9n"; -export { TableCellMessages } from "./components/table-cell/assets/table-cell/t9n"; -export { TableHeaderMessages } from "./components/table-header/assets/table-header/t9n"; -export { TextAreaMessages } from "./components/text-area/assets/text-area/t9n"; export { TileSelectType } from "./components/tile-select/interfaces"; export { TileSelectGroupLayout } from "./components/tile-select-group/interfaces"; -export { TipMessages } from "./components/tip/assets/tip/t9n"; -export { TipManagerMessages } from "./components/tip-manager/assets/tip-manager/t9n"; export { TreeItemSelectDetail } from "./components/tree-item/interfaces"; -export { ValueListMessages } from "./components/value-list/assets/value-list/t9n"; export { ListItemAndHandle } from "./components/value-list-item/interfaces"; export namespace Components { interface CalciteAccordion { diff --git a/packages/calcite-components/src/components/accordion-item/readme.md b/packages/calcite-components/src/components/accordion-item/readme.md index 66683857b7b..28b9df1fa4b 100644 --- a/packages/calcite-components/src/components/accordion-item/readme.md +++ b/packages/calcite-components/src/components/accordion-item/readme.md @@ -6,14 +6,14 @@ For comprehensive guidance on using and implementing `calcite-accordion-item`, r ## Properties -| Property | Attribute | Description | Type | Default | -| ------------- | --------------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------- | -| `description` | `description` | Specifies a description for the component. | `string` | `undefined` | -| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` | -| `heading` | `heading` | Specifies heading text for the component. | `string` | `undefined` | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | +| Property | Attribute | Description | Type | Default | +| ------------- | --------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | +| `description` | `description` | Specifies a description for the component. | `string` | `undefined` | +| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` | +| `heading` | `heading` | Specifies heading text for the component. | `string` | `undefined` | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | ## Methods diff --git a/packages/calcite-components/src/components/accordion/readme.md b/packages/calcite-components/src/components/accordion/readme.md index db0d5167739..61cf4b74b67 100644 --- a/packages/calcite-components/src/components/accordion/readme.md +++ b/packages/calcite-components/src/components/accordion/readme.md @@ -4,18 +4,6 @@ For comprehensive guidance on using and implementing `calcite-accordion`, refer -## Usage - -### Basic - -```html - - Accordion Section Content - Accordion Section Content - Accordion Section Content - -``` - ## Properties | Property | Attribute | Description | Type | Default | diff --git a/packages/calcite-components/src/components/action-bar/readme.md b/packages/calcite-components/src/components/action-bar/readme.md index 020dd1b4256..afece48d4fa 100755 --- a/packages/calcite-components/src/components/action-bar/readme.md +++ b/packages/calcite-components/src/components/action-bar/readme.md @@ -6,59 +6,6 @@ For comprehensive guidance on using and implementing `calcite-action-bar`, refer -## Usage - -### Actions-end - -The actions-end slot renders `calcite-action`s that stick to the end of the bar prior to the expand/collapse icon. - -```html - - - - -``` - -### Basic - -Renders `calcite-action`s that stick to the top of the bar. - -```html - - - - -``` - -### Tooltip - -Renders with a tooltip on the expand action. - -```html - - Expand - - -``` - -### 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. - -```html - - - - - - - - - - - -``` - ## Properties | Property | Attribute | Description | Type | Default | diff --git a/packages/calcite-components/src/components/action-menu/readme.md b/packages/calcite-components/src/components/action-menu/readme.md index 6524b961ddd..45be8580e3c 100644 --- a/packages/calcite-components/src/components/action-menu/readme.md +++ b/packages/calcite-components/src/components/action-menu/readme.md @@ -12,7 +12,7 @@ | `label` *(required)* | `label` | Specifies the text string for the component. | `string` | `undefined` | | `open` | `open` | When `true`, the component is open. | `boolean` | `false` | | `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | -| `placement` | `placement` | Determines where the component will be positioned relative to the `referenceElement`. | `"auto" \| "top" \| "bottom" \| "right" \| "left" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "right-start" \| "right-end" \| "left-start" \| "left-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `"auto"` | +| `placement` | `placement` | Determines where the component will be positioned relative to the `referenceElement`. | `"auto" \| "top" \| "bottom" \| "left" \| "right" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "left-start" \| "left-end" \| "right-start" \| "right-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `"auto"` | | `scale` | `scale` | Specifies the size of the component's trigger `calcite-action`. | `"l" \| "m" \| "s"` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/action-pad/readme.md b/packages/calcite-components/src/components/action-pad/readme.md index 644345d0082..9d64ff39d12 100755 --- a/packages/calcite-components/src/components/action-pad/readme.md +++ b/packages/calcite-components/src/components/action-pad/readme.md @@ -4,45 +4,6 @@ For comprehensive guidance on using and implementing `calcite-action-pad`, refer -## Usage - -### Basic - -Renders a basic action pad with `calcite-action`s. - -```html - - - - -``` - -### Tooltip - -Renders an action pad with a tooltip on the expand action. - -```html - - - Let's expand - -``` - -### 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. - -```html - - - - - - - - -``` - ## Properties | Property | Attribute | Description | Type | Default | diff --git a/packages/calcite-components/src/components/action/readme.md b/packages/calcite-components/src/components/action/readme.md index 93e0d779baa..08e1444516f 100755 --- a/packages/calcite-components/src/components/action/readme.md +++ b/packages/calcite-components/src/components/action/readme.md @@ -4,60 +4,24 @@ For comprehensive guidance on using and implementing `calcite-action`, refer to -## Usage - -### Transparent-appearance - -Renders a `calcite-action` that is transparent. - -```html - -``` - -### With-text-displayed - -Renders a `calcite-action` that displays text alongside an icon. - -```html - -``` - -### With-tooltip - -Renders a `calcite-action` that displays text alongside an icon. A `calcite-tooltip` will be displayed on hover or focus. - -```html -Save me! -``` - -### Without-text-displayed - -Renders a `calcite-action` that displays only an icon. - -```html - -``` - ## Properties -| Property | Attribute | Description | Type | Default | -| ------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | ----------- | -| `active` | `active` | When `true`, the component is highlighted. | `boolean` | `false` | -| `alignment` | `alignment` | Specifies the horizontal alignment of button elements with text content. | `"center" \| "end" \| "start"` | `undefined` | -| `appearance` | `appearance` | Specifies the appearance of the component. | `"solid" \| "transparent"` | `"solid"` | -| `compact` | `compact` | When `true`, the side padding of the component is reduced. Compact mode is used internally by components, e.g. `calcite-block-section`. | `boolean` | `false` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `icon` | `icon` | Specifies an icon to display. | `string` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | -| `indicator` | `indicator` | When `true`, displays a visual indicator. | `boolean` | `false` | -| `label` | `label` | Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop. | `string` | `undefined` | -| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ActionMessages` | `undefined` | -| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | -| `text` *(required)* | `text` | Specifies text that accompanies the icon. | `string` | `undefined` | -| `textEnabled` | `text-enabled` | Indicates whether the text is displayed. | `boolean` | `false` | +| Property | Attribute | Description | Type | Default | +| ------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | +| `active` | `active` | When `true`, the component is highlighted. | `boolean` | `false` | +| `alignment` | `alignment` | Specifies the horizontal alignment of button elements with text content. | `"center" \| "end" \| "start"` | `undefined` | +| `appearance` | `appearance` | Specifies the appearance of the component. | `"solid" \| "transparent"` | `"solid"` | +| `compact` | `compact` | When `true`, the side padding of the component is reduced. Compact mode is used internally by components, e.g. `calcite-block-section`. | `boolean` | `false` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `icon` | `icon` | Specifies an icon to display. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | +| `indicator` | `indicator` | When `true`, displays a visual indicator. | `boolean` | `false` | +| `label` | `label` | Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop. | `string` | `undefined` | +| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ActionMessages` | `undefined` | +| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` | +| `text` *(required)* | `text` | Specifies text that accompanies the icon. | `string` | `undefined` | +| `textEnabled` | `text-enabled` | Indicates whether the text is displayed. | `boolean` | `false` | ## Methods diff --git a/packages/calcite-components/src/components/alert/readme.md b/packages/calcite-components/src/components/alert/readme.md index 6a9b629f729..b9345015c29 100644 --- a/packages/calcite-components/src/components/alert/readme.md +++ b/packages/calcite-components/src/components/alert/readme.md @@ -4,27 +4,13 @@ For comprehensive guidance on using and implementing `calcite-alert`, refer to t -## Usage - -### Basic - -A single instance of an alert. Multiple alerts will aggregate in a queue. - -```html - -
Title of alert
-
Message text of the alert
- Retry - -``` - ## Properties | Property | Attribute | Description | Type | Default | | -------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ----------- | | `autoClose` | `auto-close` | When `true`, the component closes automatically. Recommended for passive, non-blocking alerts. | `boolean` | `false` | | `autoCloseDuration` | `auto-close-duration` | Specifies the duration before the component automatically closes - only use with `autoClose`. | `"fast" \| "medium" \| "slow"` | `"medium"` | -| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| string` | `undefined` | +| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| IconName` | `undefined` | | `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` | | `kind` | `kind` | Specifies the kind of the component, which will apply to top border and icon. | `"brand" \| "danger" \| "info" \| "success" \| "warning"` | `"brand"` | | `label` *(required)* | `label` | Specifies an accessible name for the component. | `string` | `undefined` | diff --git a/packages/calcite-components/src/components/avatar/readme.md b/packages/calcite-components/src/components/avatar/readme.md index 187a60ca0b5..52fd13b7d50 100644 --- a/packages/calcite-components/src/components/avatar/readme.md +++ b/packages/calcite-components/src/components/avatar/readme.md @@ -4,38 +4,6 @@ For comprehensive guidance on using and implementing `calcite-avatar`, refer to -## 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. - -When 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. - -**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`. - -```json -{ - "username": "ron_swanson_pawnee", - "id": "a81470986eaeee1833b74b7d8abcd5b2", - "fullName": "Ron Swanson", - "firstName": "Ron", - "lastName": "Swanson", - "thumbnail": "mySelf.jpg", - ... -} -``` - -```html - - -``` - ## Properties | Property | Attribute | Description | Type | Default | diff --git a/packages/calcite-components/src/components/block-section/readme.md b/packages/calcite-components/src/components/block-section/readme.md index 9df4f6b6195..7dfdebf4cd8 100644 --- a/packages/calcite-components/src/components/block-section/readme.md +++ b/packages/calcite-components/src/components/block-section/readme.md @@ -6,16 +6,16 @@ For comprehensive guidance on using and implementing `calcite-block-section`, re ## Properties -| Property | Attribute | Description | Type | Default | -| ------------------ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ----------- | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `BlockSectionMessages` | `undefined` | -| `open` | `open` | When `true`, expands the component and its contents. | `boolean` | `false` | -| `status` | `status` | **[DEPRECATED]** Use `icon-start` instead.

Displays a status-related indicator icon. | `"idle" \| "invalid" \| "valid"` | `undefined` | -| `text` | `text` | The component header text. | `string` | `undefined` | -| `toggleDisplay` | `toggle-display` | Specifies how the component's toggle is displayed, where: `"button"` sets the toggle to a selectable header, and `"switch"` sets the toggle to a switch. | `"button" \| "switch"` | `"button"` | +| Property | Attribute | Description | Type | Default | +| ------------------ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `BlockSectionMessages` | `undefined` | +| `open` | `open` | When `true`, expands the component and its contents. | `boolean` | `false` | +| `status` | `status` | **[DEPRECATED]** Use `icon-start` instead.

Displays a status-related indicator icon. | `"idle" \| "invalid" \| "valid"` | `undefined` | +| `text` | `text` | The component header text. | `string` | `undefined` | +| `toggleDisplay` | `toggle-display` | Specifies how the component's toggle is displayed, where: `"button"` sets the toggle to a selectable header, and `"switch"` sets the toggle to a switch. | `"button" \| "switch"` | `"button"` | ## Events diff --git a/packages/calcite-components/src/components/block/readme.md b/packages/calcite-components/src/components/block/readme.md index ef91c462406..48c3c41302b 100644 --- a/packages/calcite-components/src/components/block/readme.md +++ b/packages/calcite-components/src/components/block/readme.md @@ -4,84 +4,24 @@ For comprehensive guidance on using and implementing `calcite-block`, refer to t -## Usage - -### Always-open - -Renders a header and content that remains open - no collapsible option. - -```html - - - -``` - -### Basic - -Renders a basic, non-collapsible block. - -```html - -``` - -### Collapsible - -Renders a header with a clickable icon to toggle the block open and closed. - -```html - - - - - -``` - -### Header-with-control - -Renders a header and control with a slot for adding a single HTML element (in the header). - -```html - - - -``` - -### Header-with-icon - -Renders a header and icon with the icon. - -```html - -
🐕
- -``` - ## Properties -| Property | Attribute | Description | Type | Default | -| ---------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------ | -| `collapsible` | `collapsible` | When `true`, the component is collapsible. | `boolean` | `false` | -| `description` | `description` | A description for the component, which displays below the heading. | `string` | `undefined` | -| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | -| `dragHandle` | `drag-handle` | When `true`, displays a drag handle in the header. | `boolean` | `false` | -| `heading` *(required)* | `heading` | The component header text. | `string` | `undefined` | -| `headingLevel` | `heading-level` | Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling. | `1 \| 2 \| 3 \| 4 \| 5 \| 6` | `undefined` | -| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` | -| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | -| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` | -| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | -| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `BlockMessages` | `undefined` | -| `open` | `open` | When `true`, expands the component and its contents. | `boolean` | `false` | -| `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | -| `status` | `status` | **[DEPRECATED]** Use `icon-start` instead.

Displays a status-related indicator icon. | `"idle" \| "invalid" \| "valid"` | `undefined` | +| Property | Attribute | Description | Type | Default | +| ---------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | +| `collapsible` | `collapsible` | When `true`, the component is collapsible. | `boolean` | `false` | +| `description` | `description` | A description for the component, which displays below the heading. | `string` | `undefined` | +| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` | +| `dragHandle` | `drag-handle` | When `true`, displays a drag handle in the header. | `boolean` | `false` | +| `heading` *(required)* | `heading` | The component header text. | `string` | `undefined` | +| `headingLevel` | `heading-level` | Specifies the heading level of the component's `heading` for proper document structure, without affecting visual styling. | `1 \| 2 \| 3 \| 4 \| 5 \| 6` | `undefined` | +| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | +| `iconFlipRtl` | `icon-flip-rtl` | Displays the `iconStart` and/or `iconEnd` as flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` | +| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `CamelCaseIcons \| "date-time" \| "i12-x" \| "i14-x" \| "i18-x" \| "i1-x" \| "i2-d-explore" \| "i2-x" \| "i360-view" \| "i3-d-glasses" \| "i4-x" \| "i8-x" \| "a-z" \| "a-z-down" \| "a-z-up" \| "absolute-direction" \| "absolute-elevation" \| "access-string-results" \| "activity-monitor" \| "actual-size" \| "add-and-update-features" \| "add-constant" \| "add-features" \| "add-in" \| "add-in-edit" \| "add-in-new" \| "add-layer" \| "add-layer-service" \| "add-raster-variable" \| "add-rasters" \| "add-reaction" \| "add-text" \| "add-to-model" \| "address-book" \| "alert-off-circle-f" \| "all-servers" \| "analysis-overlay" \| "annotate-tool" \| "antenna-height" \| "app-gear" \| "app-launcher" \| "app-run" \| "app-update" \| "apply-changes" \| "apply-selection-to-existing-view" \| "arcgis-online" \| "arrow-bold-down" \| "arrow-bold-left" \| "arrow-bold-right" \| "arrow-bold-up" \| "arrow-circle-down" \| "arrow-circle-down-f" \| "arrow-double-diagonal1" \| "arrow-double-diagonal2" \| "arrow-double-horizontal" \| "arrow-double-vertical" \| "arrow-down" \| "arrow-down-left" \| "arrow-down-right" \| "arrow-left" \| "arrow-right" \| "arrow-right-left" \| "arrow-up" \| "arrow-up-down" \| "arrow-up-left" \| "arrow-up-right" \| "asterisk-large" \| "asterisk-small" \| "attachment-plus" \| "auto-layout" \| "battery-charging" \| "bear-left" \| "bear-right" \| "beginning-f" \| "bell-f" \| "bell-off" \| "bookmark-f" \| "border-radius-fully-rounded" \| "border-radius-rounded" \| "border-radius-sharp" \| "box-chart" \| "box-chart-series" \| "brackets-curly" \| "break-recurrence" \| "bring-forward" \| "bring-to-front" \| "browser-map" \| "brush-mark" \| "brush-mark-plus" \| "brush-tip" \| "bullet-point" \| "bullet-point-large" \| "camera-flash-off" \| "camera-flash-on" \| "camera-plus" \| "camera-switch-front-back" \| "camera-unlock" \| "caret-double-horizontal" \| "caret-double-vertical" \| "caret-down" \| "caret-left" \| "caret-right" \| "caret-square-down" \| "caret-square-left" \| "caret-square-right" \| "caret-square-up" \| "caret-up" \| "catalog-dataset" \| "center-align" \| "center-horizontal" \| "center-vertical" \| "change-detection" \| "change-font-size" \| "chart-gear" \| "chart-magnifying-glass" \| "check-circle" \| "check-circle-f" \| "check-extent" \| "check-layer" \| "check-shield" \| "check-square" \| "check-square-f" \| "chevron-down" \| "chevron-down-left" \| "chevron-down-right" \| "chevron-end" \| "chevron-left" \| "chevron-right" \| "chevron-start" \| "chevron-up" \| "chevron-up-left" \| "chevron-up-right" \| "chevrons-down" \| "chevrons-left" \| "chevrons-right" \| "chevrons-up" \| "chord-diagram" \| "circle-f" \| "circle-area" \| "circle-disallowed" \| "circle-pause" \| "circle-pause-f" \| "circle-stop" \| "circle-stop-f" \| "classify-objects" \| "classify-pixels" \| "clear-selection" \| "clipboard-brackets" \| "clock-down" \| "clock-forward" \| "clock-up" \| "code-branch" \| "code-branch-edit" \| "collaboration-distributed" \| "collaboration-user" \| "color-coded-map" \| "color-correction" \| "column-settings" \| "community-link-chart-layout" \| "compass-needle" \| "compass-north-circle" \| "conditional-rules" \| "conditional-rules-path" \| "conference-room" \| "configure-editing" \| "configure-grid-unit" \| "configure-popup" \| "content-full" \| "content-inline" \| "content-large" \| "content-medium" \| "content-minimal" \| "content-none" \| "content-side-by-side" \| "content-small" \| "contingent-values" \| "coordinate-system" \| "copy-to-clipboard" \| "credit-card" \| "cursor-click" \| "cursor-lock" \| "cursor-marquee" \| "cursor-minus" \| "cursor-plus" \| "cursor-selection" \| "cut-and-fill-volume-calculation" \| "data-card" \| "data-check" \| "data-clock-chart" \| "data-cloud" \| "data-folder" \| "data-magnifying-glass" \| "data-raster" \| "debug-script" \| "decrease-link-chart-symbol-size" \| "deep-learning" \| "deep-learning-project" \| "derived-value" \| "developer-credentials" \| "dimensions-unit" \| "dimensions-wall" \| "display-selection-lock" \| "display-selection-unlock" \| "dissolve-features" \| "distance-type" \| "distribute-height-evenly" \| "distribute-width-evenly" \| "dock-bottom" \| "dock-left" \| "dock-right" \| "double-float" \| "download-to" \| "drive-time" \| "drive-time-largest" \| "drive-time-smallest" \| "drive-time-threshold" \| "drive-time-x-bar" \| "driving-distance" \| "driving-time" \| "drone-fixed-wing" \| "drone-flying-wing" \| "drone-quadcopter" \| "drone-quadcopter-top" \| "edit-attributes" \| "edit-geometry" \| "elevator-down" \| "elevator-up" \| "ellipsis-circle" \| "email-address" \| "embedded-card" \| "embedded-content" \| "embedded-live-content" \| "employee-id" \| "enable-disable-feature-selection" \| "end-f" \| "escalator-down" \| "escalator-up" \| "exclamation-mark-circle" \| "exclamation-mark-circle-f" \| "exclamation-mark-triangle" \| "exclamation-mark-triangle-f" \| "exit-highway-left" \| "exit-highway-right" \| "expression-defined-color" \| "extend-trim" \| "extent-filter" \| "face-id" \| "feature-details" \| "feature-layer" \| "file-archive" \| "file-cad" \| "file-code" \| "file-csv" \| "file-data" \| "file-ecd" \| "file-excel" \| "file-gpx" \| "file-image" \| "file-kml" \| "file-magnifying-glass" \| "file-pdf" \| "file-pdf-plus" \| "file-pitemx" \| "file-ppt" \| "file-report" \| "file-report-generic" \| "file-shape" \| "file-sound" \| "file-sqlite" \| "file-text" \| "file-user" \| "file-video" \| "file-word" \| "file-xml" \| "file-zip" \| "files-csv-collection" \| "filter-expand" \| "find-path" \| "flip-vertical" \| "floor-plan" \| "folder-f" \| "folder-archive" \| "folder-magnifying-glass" \| "folder-move" \| "folder-new" \| "folder-open" \| "folder-open-f" \| "folder-plus" \| "folder-star" \| "folder-video" \| "follow-pause" \| "follow-play" \| "force-directed-link-chart-layout" \| "fork-left" \| "fork-middle" \| "fork-right" \| "form-dropdown" \| "form-elements" \| "form-field" \| "form-field-multiline" \| "form-field-off" \| "forward-f" \| "four-by-one-grid" \| "four-by-three-grid" \| "four-by-two-grid" \| "frame-export" \| "freehand-area" \| "full-screen" \| "full-screen-exit" \| "function-editor" \| "gauge-summary" \| "geoanalytics-server" \| "geoevent-server" \| "geographic-link-chart-layout" \| "geonet-question" \| "gis-server" \| "gps-off" \| "gps-on" \| "gps-on-f" \| "graph-axis" \| "graph-bar100-stacked" \| "graph-bar" \| "graph-bar-side-by-side" \| "graph-bar-stacked" \| "graph-box-mean-lines" \| "graph-box-side-by-side" \| "graph-guides" \| "graph-histogram" \| "graph-line-series" \| "graph-moving-average" \| "graph-pie-slice" \| "graph-scatter-plot" \| "graph-time-series" \| "grid-diamond" \| "grid-hexagon" \| "grid-triangle" \| "grid-unit" \| "ground-control-point" \| "group-form" \| "group-form-plus" \| "group-items" \| "group-layers" \| "group-layout-elements" \| "group-x" \| "h3-hexagon" \| "handle-vertical" \| "heading-layout" \| "heading-rtl" \| "heart-f" \| "heat-chart" \| "heavy-rain" \| "heavy-snow" \| "hide-derived-value" \| "hide-empty" \| "hide-layers" \| "hide-parameters" \| "hierarchical-link-chart-layout" \| "highlighter-tip" \| "highway-change" \| "highway-change-right" \| "hillshade-effect" \| "horizontal-distribute" \| "hourglass-active" \| "hourglass-expired" \| "image-chips" \| "image-collection-explorer" \| "image-display-order" \| "image-layer" \| "image-magnifying-glass" \| "image-mensuration" \| "image-pin" \| "image-plus" \| "image-segmentation" \| "image-server" \| "image-space" \| "image-unit" \| "increase-link-chart-symbol-size" \| "information-f" \| "information-letter" \| "initiative-template" \| "joined-view-layer" \| "knowledge-graph" \| "knowledge-graph-dashboard" \| "knowledge-graph-data-model" \| "knowledge-graph-export" \| "knowledge-graph-import" \| "knowledge-graph-new" \| "knowledge-graph-relationship" \| "knowledge-layer" \| "knowledge-server" \| "knowledge-studio" \| "label-off" \| "language-translate" \| "lasso-select" \| "layer-basemap" \| "layer-broken" \| "layer-filter" \| "layer-graphics" \| "layer-hide" \| "layer-kml" \| "layer-line" \| "layer-line-service" \| "layer-map" \| "layer-map-service" \| "layer-points" \| "layer-polygon" \| "layer-polygon-service" \| "layer-service" \| "layer-settings" \| "layer-zoom-to" \| "layers-editable" \| "layers-f" \| "layers-reference" \| "layout-compact" \| "layout-horizontal" \| "layout-spacious" \| "layout-vertical" \| "left-align" \| "left-edge" \| "left-left" \| "left-right" \| "legend-left" \| "legend-plus" \| "legend-right" \| "light-rain" \| "light-snow" \| "line-check" \| "line-dashed" \| "line-dotted" \| "line-of-sight" \| "line-solid" \| "line-straight" \| "link-chart" \| "link-chart-expand" \| "link-chart-from-template" \| "list-bullet" \| "list-button" \| "list-check" \| "list-check-all" \| "list-merge" \| "list-number" \| "list-number-rtl" \| "list-radio" \| "list-rectangle" \| "list-show-all" \| "livestream-video-layer" \| "location-sharing" \| "location-sharing-f" \| "location-sharing-off" \| "lock-f" \| "ltr-elements-align" \| "ltr-paragraph-align" \| "magnifying-glass" \| "magnifying-glass-minus" \| "magnifying-glass-plus" \| "map-contents" \| "map-from-template" \| "map-level-settings" \| "map-pin" \| "map-space" \| "mask-inside" \| "mask-outside" \| "maximum-graph" \| "maximum-territory-distance" \| "measure-area" \| "measure-building-height-shadow" \| "measure-building-height-top-base" \| "measure-building-height-top-shadow" \| "measure-line" \| "media-layer" \| "mega-phone" \| "members-brackets" \| "merge-details" \| "merge-on-highway" \| "merge-on-highway-right" \| "merge-units" \| "microphone-plus" \| "min-distance-between-centers" \| "minimum-graph" \| "minus-circle" \| "minus-circle-f" \| "minus-square" \| "minus-square-f" \| "miscellaneous-collection" \| "mission-server" \| "mobile-off" \| "mobile-vibrate" \| "model-edit" \| "modify-associations" \| "move-from-basemap" \| "move-to-basemap" \| "move-up" \| "move-up-all" \| "multidimensional-raster" \| "multiple-variables" \| "music-note" \| "new-link-chart" \| "new-model" \| "new-raster-function-template" \| "new-training" \| "no-attachment" \| "no-image" \| "no-map" \| "nodes-link" \| "nodes-merge" \| "nodes-unlink" \| "nodes-unmerge" \| "notebook-server" \| "notebook-snapshot" \| "notepad-add" \| "notepad-edit" \| "number-circle1" \| "number-circle1-f" \| "number-circle2" \| "number-circle2-f" \| "number-circle3" \| "number-circle3-f" \| "number-circle4" \| "number-circle4-f" \| "number-circle5" \| "number-circle5-f" \| "number-circle6" \| "number-circle6-f" \| "number-circle7" \| "number-circle7-f" \| "number-circle8" \| "number-circle8-f" \| "number-circle9" \| "number-circle9-f" \| "number-of-territories" \| "object-detection" \| "on-the-ground-elevation" \| "open-book" \| "oriented-imagery-layer" \| "oriented-imagery-widget" \| "overlap-features" \| "overwrite-features" \| "paint-bucket" \| "palette-check" \| "pan-drag" \| "parcel-layer" \| "partly-cloudy" \| "paste-with-attribute" \| "paste-without-attribute" \| "pause-f" \| "pen-mark" \| "pen-mark-plus" \| "pen-tip" \| "pencil-mark" \| "pencil-mark-plus" \| "pencil-square" \| "pencil-tip" \| "personal-homepage" \| "pie-chart" \| "pin-plus" \| "pin-tear" \| "pin-tear-f" \| "play-f" \| "plus-circle" \| "plus-square" \| "point-line" \| "polygon-area" \| "polygon-line-check" \| "polygon-select" \| "polygon-vertices" \| "pop-up1" \| "pop-up-blank" \| "pop-up-blank-f" \| "premium-content-user-credit" \| "presentation-x" \| "print-preview" \| "processing-templates" \| "profile-variables" \| "project-mission" \| "project-template" \| "puzzle-piece" \| "qr-code" \| "qt-code" \| "question-f" \| "question-mark" \| "radial-tree-link-chart-layout" \| "rain-snow" \| "rain-thunder" \| "ramp-left" \| "ramp-right" \| "raster-analysis" \| "raster-function" \| "raster-function-template" \| "raster-function-template-play" \| "read-only-non-editable" \| "rectangle-area" \| "rectangle-plus" \| "recycle-bin" \| "refresh-f" \| "relative-direction" \| "relative-to-ground-elevation" \| "relative-to-scene-elevation" \| "remove-from-list" \| "remove-linkchart" \| "reorder-cards" \| "reorder-grid" \| "reorder-stack" \| "replace-image" \| "reshape-add-geometry" \| "reshape-subtract-geometry" \| "reshape-tool" \| "resize-area" \| "reverse-f" \| "ribbon-rosette" \| "right-align" \| "right-angle" \| "right-edge" \| "right-left" \| "right-right" \| "rings-largest" \| "rings-smallest" \| "rings-threshold" \| "rings-x-bar" \| "road-sign" \| "rotate-device" \| "round-about" \| "round-about-right" \| "rounded-rectangle" \| "route-from" \| "route-to" \| "rss-f" \| "rtl-elements-align" \| "rtl-paragraph-align" \| "running-outline" \| "rural-driving-distance" \| "rural-driving-time" \| "satellite0-f" \| "satellite1-f" \| "satellite2-f" \| "satellite3-f" \| "save-as" \| "scan-area" \| "scan-barcode" \| "scan-corridor" \| "scan-crosshatch" \| "scan-perimeter" \| "scan-vertical" \| "screenshot-mode" \| "select-by-attributes" \| "select-category" \| "select-column" \| "select-range" \| "select-visible" \| "selected-items-filter" \| "selection-filter" \| "selection-manager" \| "selection-set" \| "selection-x" \| "send-backwards" \| "send-to-back" \| "serial-port" \| "server-lock" \| "share-ios" \| "sharp-left" \| "sharp-right" \| "shield-coin" \| "shopping-cart" \| "show-all-parameters" \| "show-column" \| "show-derived-value" \| "show-multiple-layers-at-a-time" \| "show-one-layer-at-a-time" \| "show-required-parameters" \| "sign-in" \| "sign-out" \| "simple-link-chart-layout" \| "sky-plot" \| "sliders-horizontal" \| "smart-camera" \| "smart-form" \| "smart-tree-link-chart-layout" \| "snap-to-grid" \| "snap-to-pixel" \| "snap-to-point" \| "snow-thunder" \| "sort-ascending" \| "sort-ascending-arrow" \| "sort-descending" \| "sort-descending-arrow" \| "sound-low" \| "sound-off" \| "sound-unavailable" \| "speech-bubble" \| "speech-bubble-check" \| "speech-bubble-exclamation" \| "speech-bubble-like" \| "speech-bubble-plus" \| "speech-bubble-social" \| "speech-bubbles" \| "split-features" \| "split-geometry" \| "split-units" \| "square-f" \| "square-area" \| "stairs-down" \| "stairs-up" \| "star-f" \| "star-circle" \| "stop-square" \| "stop-square-f" \| "stored-as-new-query" \| "stored-query" \| "sub-fields" \| "subheading-rtl" \| "suitability-analysis-output" \| "summarize-center-and-dispersion1" \| "summarize-center-and-dispersion2" \| "summarize-center-and-dispersion3" \| "system-management" \| "tabbed-view" \| "take-pedestrian-ramp" \| "territory-buffer-distance" \| "test-data" \| "text-bold" \| "text-button" \| "text-dashed-underline" \| "text-large" \| "text-medium" \| "text-paragraph-large" \| "text-small" \| "text-solid-underline" \| "three-by-one-grid" \| "three-by-three-grid" \| "three-by-two-grid" \| "thumbs-down" \| "thumbs-up" \| "tile-layer" \| "tiled-imagery-layer" \| "time-filter" \| "time-zone" \| "toggle-off" \| "toggle-on" \| "tour-pin-tear" \| "transverse-hexagon" \| "trapezoid-area" \| "trucking-distance" \| "trucking-time" \| "u-turn" \| "u-turn-right" \| "ungroup-items" \| "ungroup-layers" \| "ungroup-layout-elements" \| "update-features" \| "update-project" \| "upload-to" \| "urban-model" \| "usb-security-key" \| "user-calendar" \| "user-down" \| "user-key" \| "user-minus" \| "user-plus" \| "user-to-device" \| "user-up" \| "user-x" \| "utility-network" \| "utility-network-trace" \| "validate-utility-network-topology" \| "vertex-check" \| "vertex-edit" \| "vertex-gps" \| "vertex-move" \| "vertex-plus" \| "vertex-x" \| "vertical-distribute" \| "video-layer" \| "video-plus" \| "video-server" \| "video-single-server" \| "video-web" \| "view-associations" \| "view-hide" \| "view-mixed" \| "view-visible" \| "walk-through-door" \| "walking-distance" \| "walking-time" \| "widgets-group" \| "widgets-source" \| "widgets-tabs" \| "workflow-diagram" \| "workflow-manager-server" \| "x-axis-guide" \| "x-bar" \| "x-circle" \| "x-circle-f" \| "x-octagon" \| "x-octagon-f" \| "y-axis-guide" \| "zoom-in-fixed" \| "zoom-out-fixed" \| "zoom-to-object"` | `undefined` | +| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` | +| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `BlockMessages` | `undefined` | +| `open` | `open` | When `true`, expands the component and its contents. | `boolean` | `false` | +| `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` | +| `status` | `status` | **[DEPRECATED]** Use `icon-start` instead.

Displays a status-related indicator icon. | `"idle" \| "invalid" \| "valid"` | `undefined` | ## Events diff --git a/packages/calcite-components/src/components/button/readme.md b/packages/calcite-components/src/components/button/readme.md index 49dd40dcf92..b9f37334032 100644 --- a/packages/calcite-components/src/components/button/readme.md +++ b/packages/calcite-components/src/components/button/readme.md @@ -4,88 +4,31 @@ For comprehensive guidance on using and implementing `calcite-button`, refer to -## Usage - -### Basic - -```html -Go! -``` - -### Focusing - -You can programmatically focus a `calcite-button` with the `setFocus()` method: - -```html -
Focus!
-``` - -### Internals - -Any additional attributes set on `` are passed to the internal `` or `