Skip to content

Commit e143395

Browse files
benelangithub-actions[bot]
benelan
authored and
github-actions[bot]
committed
docs: update component READMEs
1 parent 3319135 commit e143395

File tree

39 files changed

+287
-383
lines changed

39 files changed

+287
-383
lines changed

‎packages/calcite-components/src/components.d.ts

Lines changed: 0 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -9,185 +9,87 @@ import { Alignment, Appearance, CollapseDirection, FlipContext, IconType, Kind,
99
import { RequestedItem } from "./components/accordion/interfaces";
1010
import { IconName } from "./components/icon/interfaces";
1111
import { RequestedItem as RequestedItem1 } from "./components/accordion-item/interfaces";
12-
import { ActionMessages } from "./components/action/assets/action/t9n";
1312
import { FlipPlacement, LogicalPlacement, MenuPlacement, OverlayPositioning, ReferenceElement } from "./utils/floating-ui";
14-
import { ActionBarMessages } from "./components/action-bar/assets/action-bar/t9n";
1513
import { Columns } from "./components/action-group/interfaces";
16-
import { ActionGroupMessages } from "./components/action-group/assets/action-group/t9n";
17-
import { ActionPadMessages } from "./components/action-pad/assets/action-pad/t9n";
1814
import { AlertDuration, Sync } from "./components/alert/interfaces";
1915
import { NumberingSystem } from "./utils/locale";
20-
import { AlertMessages } from "./components/alert/assets/alert/t9n";
2116
import { HeadingLevel } from "./components/functional/Heading";
22-
import { BlockMessages } from "./components/block/assets/block/t9n";
2317
import { BlockSectionToggleDisplay } from "./components/block-section/interfaces";
24-
import { BlockSectionMessages } from "./components/block-section/assets/block-section/t9n";
2518
import { ButtonAlignment, DropdownIconType } from "./components/button/interfaces";
26-
import { ButtonMessages } from "./components/button/assets/button/t9n";
27-
import { CardMessages } from "./components/card/assets/card/t9n";
2819
import { ArrowType, AutoplayType } from "./components/carousel/interfaces";
29-
import { CarouselMessages } from "./components/carousel/assets/carousel/t9n";
3020
import { MutableValidityState } from "./utils/form";
31-
import { ChipMessages } from "./components/chip/assets/chip/t9n";
3221
import { ColorValue, InternalColor } from "./components/color-picker/interfaces";
3322
import { Format } from "./components/color-picker/utils";
34-
import { ColorPickerMessages } from "./components/color-picker/assets/color-picker/t9n";
3523
import { ComboboxChildElement, SelectionDisplay } from "./components/combobox/interfaces";
36-
import { ComboboxMessages } from "./components/combobox/assets/combobox/t9n";
37-
import { DatePickerMessages } from "./components/date-picker/assets/date-picker/t9n";
3824
import { DateLocaleData } from "./components/date-picker/utils";
3925
import { HoverRange } from "./utils/date";
4026
import { RequestedItem as RequestedItem2 } from "./components/dropdown-group/interfaces";
4127
import { ItemKeyboardEvent } from "./components/dropdown/interfaces";
42-
import { FilterMessages } from "./components/filter/assets/filter/t9n";
4328
import { FlowItemLikeElement } from "./components/flow/interfaces";
44-
import { FlowItemMessages } from "./components/flow-item/assets/flow-item/t9n";
4529
import { ColorStop, DataSeries } from "./components/graph/interfaces";
46-
import { HandleMessages } from "./components/handle/assets/handle/t9n";
4730
import { HandleChange, HandleNudge } from "./components/handle/interfaces";
48-
import { InlineEditableMessages } from "./components/inline-editable/assets/inline-editable/t9n";
4931
import { InputPlacement } from "./components/input/interfaces";
50-
import { InputMessages } from "./components/input/assets/input/t9n";
51-
import { InputDatePickerMessages } from "./components/input-date-picker/assets/input-date-picker/t9n";
52-
import { InputNumberMessages } from "./components/input-number/assets/input-number/t9n";
53-
import { InputTextMessages } from "./components/input-text/assets/input-text/t9n";
54-
import { InputTimePickerMessages } from "./components/input-time-picker/assets/input-time-picker/t9n";
55-
import { TimePickerMessages } from "./components/time-picker/assets/time-picker/t9n";
56-
import { InputTimeZoneMessages } from "./components/input-time-zone/assets/input-time-zone/t9n";
5732
import { OffsetStyle, TimeZoneMode } from "./components/input-time-zone/interfaces";
5833
import { ListDragDetail } from "./components/list/interfaces";
5934
import { ItemData } from "./components/list-item/interfaces";
60-
import { ListMessages } from "./components/list/assets/list/t9n";
6135
import { SelectionAppearance } from "./components/list/resources";
62-
import { ListItemMessages } from "./components/list-item/assets/list-item/t9n";
63-
import { MenuMessages } from "./components/menu/assets/menu/t9n";
64-
import { MenuItemMessages } from "./components/menu-item/assets/menu-item/t9n";
6536
import { MenuItemCustomEvent } from "./components/menu-item/interfaces";
6637
import { MeterFillType, MeterLabelType } from "./components/meter/interfaces";
67-
import { ModalMessages } from "./components/modal/assets/modal/t9n";
68-
import { NoticeMessages } from "./components/notice/assets/notice/t9n";
69-
import { PaginationMessages } from "./components/pagination/assets/pagination/t9n";
70-
import { PanelMessages } from "./components/panel/assets/panel/t9n";
7138
import { ItemData as ItemData1, ListFocusId } from "./components/pick-list/shared-list-logic";
7239
import { ICON_TYPES } from "./components/pick-list/resources";
73-
import { PickListItemMessages } from "./components/pick-list-item/assets/pick-list-item/t9n";
74-
import { PopoverMessages } from "./components/popover/assets/popover/t9n";
75-
import { RatingMessages } from "./components/rating/assets/rating/t9n";
76-
import { ScrimMessages } from "./components/scrim/assets/scrim/t9n";
7740
import { DisplayMode } from "./components/sheet/interfaces";
7841
import { DisplayMode as DisplayMode1 } from "./components/shell-panel/interfaces";
79-
import { ShellPanelMessages } from "./components/shell-panel/assets/shell-panel/t9n";
8042
import { DragDetail } from "./utils/sortableComponent";
8143
import { StepperItemChangeEventDetail, StepperItemEventDetail, StepperItemKeyEventDetail, StepperLayout } from "./components/stepper/interfaces";
82-
import { StepperMessages } from "./components/stepper/assets/stepper/t9n";
83-
import { StepperItemMessages } from "./components/stepper-item/assets/stepper-item/t9n";
8444
import { TabID, TabLayout, TabPosition } from "./components/tabs/interfaces";
85-
import { TabNavMessages } from "./components/tab-nav/assets/tab-nav/t9n";
8645
import { TabChangeEventDetail, TabCloseEventDetail } from "./components/tab/interfaces";
87-
import { TabTitleMessages } from "./components/tab-title/assets/tab-title/t9n";
8846
import { RowType, TableInteractionMode, TableLayout, TableRowFocusEvent, TableSelectionDisplay } from "./components/table/interfaces";
89-
import { TableMessages } from "./components/table/assets/table/t9n";
90-
import { TableCellMessages } from "./components/table-cell/assets/table-cell/t9n";
91-
import { TableHeaderMessages } from "./components/table-header/assets/table-header/t9n";
92-
import { TextAreaMessages } from "./components/text-area/assets/text-area/t9n";
9347
import { TileSelectType } from "./components/tile-select/interfaces";
9448
import { TileSelectGroupLayout } from "./components/tile-select-group/interfaces";
95-
import { TipMessages } from "./components/tip/assets/tip/t9n";
96-
import { TipManagerMessages } from "./components/tip-manager/assets/tip-manager/t9n";
9749
import { TreeItemSelectDetail } from "./components/tree-item/interfaces";
98-
import { ValueListMessages } from "./components/value-list/assets/value-list/t9n";
9950
import { ListItemAndHandle } from "./components/value-list-item/interfaces";
10051
export { Alignment, Appearance, CollapseDirection, FlipContext, IconType, Kind, Layout, LogicalFlowPosition, Position, Scale, SelectionAppearance as SelectionAppearance1, SelectionMode, Status, Width } from "./components/interfaces";
10152
export { RequestedItem } from "./components/accordion/interfaces";
10253
export { IconName } from "./components/icon/interfaces";
10354
export { RequestedItem as RequestedItem1 } from "./components/accordion-item/interfaces";
104-
export { ActionMessages } from "./components/action/assets/action/t9n";
10555
export { FlipPlacement, LogicalPlacement, MenuPlacement, OverlayPositioning, ReferenceElement } from "./utils/floating-ui";
106-
export { ActionBarMessages } from "./components/action-bar/assets/action-bar/t9n";
10756
export { Columns } from "./components/action-group/interfaces";
108-
export { ActionGroupMessages } from "./components/action-group/assets/action-group/t9n";
109-
export { ActionPadMessages } from "./components/action-pad/assets/action-pad/t9n";
11057
export { AlertDuration, Sync } from "./components/alert/interfaces";
11158
export { NumberingSystem } from "./utils/locale";
112-
export { AlertMessages } from "./components/alert/assets/alert/t9n";
11359
export { HeadingLevel } from "./components/functional/Heading";
114-
export { BlockMessages } from "./components/block/assets/block/t9n";
11560
export { BlockSectionToggleDisplay } from "./components/block-section/interfaces";
116-
export { BlockSectionMessages } from "./components/block-section/assets/block-section/t9n";
11761
export { ButtonAlignment, DropdownIconType } from "./components/button/interfaces";
118-
export { ButtonMessages } from "./components/button/assets/button/t9n";
119-
export { CardMessages } from "./components/card/assets/card/t9n";
12062
export { ArrowType, AutoplayType } from "./components/carousel/interfaces";
121-
export { CarouselMessages } from "./components/carousel/assets/carousel/t9n";
12263
export { MutableValidityState } from "./utils/form";
123-
export { ChipMessages } from "./components/chip/assets/chip/t9n";
12464
export { ColorValue, InternalColor } from "./components/color-picker/interfaces";
12565
export { Format } from "./components/color-picker/utils";
126-
export { ColorPickerMessages } from "./components/color-picker/assets/color-picker/t9n";
12766
export { ComboboxChildElement, SelectionDisplay } from "./components/combobox/interfaces";
128-
export { ComboboxMessages } from "./components/combobox/assets/combobox/t9n";
129-
export { DatePickerMessages } from "./components/date-picker/assets/date-picker/t9n";
13067
export { DateLocaleData } from "./components/date-picker/utils";
13168
export { HoverRange } from "./utils/date";
13269
export { RequestedItem as RequestedItem2 } from "./components/dropdown-group/interfaces";
13370
export { ItemKeyboardEvent } from "./components/dropdown/interfaces";
134-
export { FilterMessages } from "./components/filter/assets/filter/t9n";
13571
export { FlowItemLikeElement } from "./components/flow/interfaces";
136-
export { FlowItemMessages } from "./components/flow-item/assets/flow-item/t9n";
13772
export { ColorStop, DataSeries } from "./components/graph/interfaces";
138-
export { HandleMessages } from "./components/handle/assets/handle/t9n";
13973
export { HandleChange, HandleNudge } from "./components/handle/interfaces";
140-
export { InlineEditableMessages } from "./components/inline-editable/assets/inline-editable/t9n";
14174
export { InputPlacement } from "./components/input/interfaces";
142-
export { InputMessages } from "./components/input/assets/input/t9n";
143-
export { InputDatePickerMessages } from "./components/input-date-picker/assets/input-date-picker/t9n";
144-
export { InputNumberMessages } from "./components/input-number/assets/input-number/t9n";
145-
export { InputTextMessages } from "./components/input-text/assets/input-text/t9n";
146-
export { InputTimePickerMessages } from "./components/input-time-picker/assets/input-time-picker/t9n";
147-
export { TimePickerMessages } from "./components/time-picker/assets/time-picker/t9n";
148-
export { InputTimeZoneMessages } from "./components/input-time-zone/assets/input-time-zone/t9n";
14975
export { OffsetStyle, TimeZoneMode } from "./components/input-time-zone/interfaces";
15076
export { ListDragDetail } from "./components/list/interfaces";
15177
export { ItemData } from "./components/list-item/interfaces";
152-
export { ListMessages } from "./components/list/assets/list/t9n";
15378
export { SelectionAppearance } from "./components/list/resources";
154-
export { ListItemMessages } from "./components/list-item/assets/list-item/t9n";
155-
export { MenuMessages } from "./components/menu/assets/menu/t9n";
156-
export { MenuItemMessages } from "./components/menu-item/assets/menu-item/t9n";
15779
export { MenuItemCustomEvent } from "./components/menu-item/interfaces";
15880
export { MeterFillType, MeterLabelType } from "./components/meter/interfaces";
159-
export { ModalMessages } from "./components/modal/assets/modal/t9n";
160-
export { NoticeMessages } from "./components/notice/assets/notice/t9n";
161-
export { PaginationMessages } from "./components/pagination/assets/pagination/t9n";
162-
export { PanelMessages } from "./components/panel/assets/panel/t9n";
16381
export { ItemData as ItemData1, ListFocusId } from "./components/pick-list/shared-list-logic";
16482
export { ICON_TYPES } from "./components/pick-list/resources";
165-
export { PickListItemMessages } from "./components/pick-list-item/assets/pick-list-item/t9n";
166-
export { PopoverMessages } from "./components/popover/assets/popover/t9n";
167-
export { RatingMessages } from "./components/rating/assets/rating/t9n";
168-
export { ScrimMessages } from "./components/scrim/assets/scrim/t9n";
16983
export { DisplayMode } from "./components/sheet/interfaces";
17084
export { DisplayMode as DisplayMode1 } from "./components/shell-panel/interfaces";
171-
export { ShellPanelMessages } from "./components/shell-panel/assets/shell-panel/t9n";
17285
export { DragDetail } from "./utils/sortableComponent";
17386
export { StepperItemChangeEventDetail, StepperItemEventDetail, StepperItemKeyEventDetail, StepperLayout } from "./components/stepper/interfaces";
174-
export { StepperMessages } from "./components/stepper/assets/stepper/t9n";
175-
export { StepperItemMessages } from "./components/stepper-item/assets/stepper-item/t9n";
17687
export { TabID, TabLayout, TabPosition } from "./components/tabs/interfaces";
177-
export { TabNavMessages } from "./components/tab-nav/assets/tab-nav/t9n";
17888
export { TabChangeEventDetail, TabCloseEventDetail } from "./components/tab/interfaces";
179-
export { TabTitleMessages } from "./components/tab-title/assets/tab-title/t9n";
18089
export { RowType, TableInteractionMode, TableLayout, TableRowFocusEvent, TableSelectionDisplay } from "./components/table/interfaces";
181-
export { TableMessages } from "./components/table/assets/table/t9n";
182-
export { TableCellMessages } from "./components/table-cell/assets/table-cell/t9n";
183-
export { TableHeaderMessages } from "./components/table-header/assets/table-header/t9n";
184-
export { TextAreaMessages } from "./components/text-area/assets/text-area/t9n";
18590
export { TileSelectType } from "./components/tile-select/interfaces";
18691
export { TileSelectGroupLayout } from "./components/tile-select-group/interfaces";
187-
export { TipMessages } from "./components/tip/assets/tip/t9n";
188-
export { TipManagerMessages } from "./components/tip-manager/assets/tip-manager/t9n";
18992
export { TreeItemSelectDetail } from "./components/tree-item/interfaces";
190-
export { ValueListMessages } from "./components/value-list/assets/value-list/t9n";
19193
export { ListItemAndHandle } from "./components/value-list-item/interfaces";
19294
export namespace Components {
19395
interface CalciteAccordion {

‎packages/calcite-components/src/components/accordion-item/readme.md

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

‎packages/calcite-components/src/components/action-menu/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
| `label` *(required)* | `label` | Specifies the text string for the component. | `string` | `undefined` |
1313
| `open` | `open` | When `true`, the component is open. | `boolean` | `false` |
1414
| `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"` |
15-
| `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"` |
15+
| `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"` |
1616
| `scale` | `scale` | Specifies the size of the component's trigger `calcite-action`. | `"l" \| "m" \| "s"` | `undefined` |
1717

1818
## Events

0 commit comments

Comments
 (0)