@jobber/components 7.11.1 → 7.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Menu/Menu.d.ts +21 -1
- package/dist/Menu-cjs.js +19 -21
- package/dist/Menu-es.js +21 -23
- package/dist/docs/AnimatedPresence/AnimatedPresence.md +1 -1
- package/dist/docs/Autocomplete/AutocompleteV1.md +1 -1
- package/dist/docs/Autocomplete/AutocompleteV2.md +1 -1
- package/dist/docs/Banner/Banner.md +41 -41
- package/dist/docs/Box/Box.md +5 -5
- package/dist/docs/Button/Button.md +13 -13
- package/dist/docs/Checkbox/Checkbox.md +2 -2
- package/dist/docs/Chip/Chip.md +2 -2
- package/dist/docs/Cluster/Cluster.md +3 -3
- package/dist/docs/Combobox/Combobox.md +1 -1
- package/dist/docs/ConfirmationModal/ConfirmationModal.md +3 -3
- package/dist/docs/Content/Content.md +2 -2
- package/dist/docs/Countdown/Countdown.md +1 -1
- package/dist/docs/DataList/DataList.md +24 -24
- package/dist/docs/DataTable/DataTable.md +7 -7
- package/dist/docs/Divider/Divider.md +1 -1
- package/dist/docs/Flex/Flex.md +1 -1
- package/dist/docs/Form/Form.md +1 -1
- package/dist/docs/FormField/FormField.md +6 -6
- package/dist/docs/FormatDate/FormatDate.md +1 -1
- package/dist/docs/FormatFile/FormatFile.md +22 -22
- package/dist/docs/FormatRelativeDateTime/FormatRelativeDateTime.md +1 -1
- package/dist/docs/FormatTime/FormatTime.md +1 -1
- package/dist/docs/Gallery/Gallery.md +1 -1
- package/dist/docs/Glimmer/Glimmer.md +7 -7
- package/dist/docs/Grid/Grid.md +2 -2
- package/dist/docs/Heading/Heading.md +2 -2
- package/dist/docs/Icon/Icon.md +1 -1
- package/dist/docs/InlineLabel/InlineLabel.md +1 -1
- package/dist/docs/InputDate/InputDate.md +4 -4
- package/dist/docs/InputEmail/InputEmail.md +3 -3
- package/dist/docs/InputFile/InputFile.md +7 -7
- package/dist/docs/InputNumber/InputNumber.md +5 -5
- package/dist/docs/InputPassword/InputPassword.md +3 -3
- package/dist/docs/InputPhoneNumber/InputPhoneNumber.md +2 -2
- package/dist/docs/InputText/InputText.md +7 -7
- package/dist/docs/InputTime/InputTime.md +2 -2
- package/dist/docs/LightBox/LightBox.md +17 -17
- package/dist/docs/Menu/Menu.md +122 -0
- package/dist/docs/Modal/Modal.md +1 -1
- package/dist/docs/MultiSelect/MultiSelect.md +1 -1
- package/dist/docs/Page/Page.md +9 -9
- package/dist/docs/Popover/Popover.md +11 -11
- package/dist/docs/ProgressBar/ProgressBar.md +1 -1
- package/dist/docs/RadioGroup/RadioGroup.md +1 -1
- package/dist/docs/SegmentedControl/SegmentedControl.md +2 -2
- package/dist/docs/Select/Select.md +4 -4
- package/dist/docs/SideKick/SideKick.md +1 -1
- package/dist/docs/Spinner/Spinner.md +1 -1
- package/dist/docs/Text/Text.md +3 -3
- package/dist/docs/Toast/Toast.md +1 -1
- package/package.json +2 -2
package/dist/Menu/Menu.d.ts
CHANGED
|
@@ -32,6 +32,27 @@ export interface MenuComponent {
|
|
|
32
32
|
ItemPrefix: typeof MenuItemPrefix;
|
|
33
33
|
ItemSuffix: typeof MenuItemSuffix;
|
|
34
34
|
}
|
|
35
|
+
export declare function Menu(props: MenuProps): ReactElement;
|
|
36
|
+
export declare namespace Menu {
|
|
37
|
+
var Group: typeof MenuGroup;
|
|
38
|
+
var GroupLabel: typeof MenuGroupLabel;
|
|
39
|
+
var Section: typeof MenuSection;
|
|
40
|
+
var Header: typeof MenuHeader;
|
|
41
|
+
var HeaderLabel: typeof MenuHeaderLabel;
|
|
42
|
+
var Item: React.ForwardRefExoticComponent<ComposableMenuItemProps & React.RefAttributes<HTMLElement>>;
|
|
43
|
+
var Trigger: React.ForwardRefExoticComponent<ComposableMenuTriggerProps & React.RefAttributes<HTMLDivElement>>;
|
|
44
|
+
var Content: typeof MenuContent;
|
|
45
|
+
var Separator: typeof MenuSeparator;
|
|
46
|
+
var RadioGroup: typeof MenuRadioGroup;
|
|
47
|
+
var RadioItem: React.ForwardRefExoticComponent<ComposableMenuRadioItemProps & React.RefAttributes<HTMLElement>>;
|
|
48
|
+
var Submenu: typeof MenuSubmenu;
|
|
49
|
+
var SubmenuTrigger: React.ForwardRefExoticComponent<ComposableMenuSubmenuTriggerProps & React.RefAttributes<HTMLElement>>;
|
|
50
|
+
var SubmenuContent: typeof MenuSubmenuContent;
|
|
51
|
+
var ItemIcon: typeof MenuItemIcon;
|
|
52
|
+
var ItemLabel: typeof MenuItemLabel;
|
|
53
|
+
var ItemPrefix: typeof MenuItemPrefix;
|
|
54
|
+
var ItemSuffix: typeof MenuItemSuffix;
|
|
55
|
+
}
|
|
35
56
|
declare const MenuTrigger: React.ForwardRefExoticComponent<ComposableMenuTriggerProps & React.RefAttributes<HTMLDivElement>>;
|
|
36
57
|
declare function MenuContent(props: ComposableMenuContentProps): React.JSX.Element;
|
|
37
58
|
declare function MenuSeparator(props: ComposableMenuSeparatorProps): React.JSX.Element;
|
|
@@ -65,5 +86,4 @@ declare function MenuHeader(props: MenuHeaderComposableProps): React.JSX.Element
|
|
|
65
86
|
* Menu.Header > Menu.HeaderLabel continues to compose onto the new GroupLabel.
|
|
66
87
|
*/
|
|
67
88
|
declare function MenuHeaderLabel(props: MenuHeaderLabelComposableProps): React.JSX.Element;
|
|
68
|
-
export declare const Menu: MenuComponent;
|
|
69
89
|
export {};
|
package/dist/Menu-cjs.js
CHANGED
|
@@ -914,7 +914,7 @@ function MenuComposableRoot(props) {
|
|
|
914
914
|
return (React.createElement(MenuContext.Provider, { value: { isMobile } },
|
|
915
915
|
React.createElement(RootComponent, { onOpenChange: props.onOpenChange, open: props.open, defaultOpen: props.defaultOpen }, props.children)));
|
|
916
916
|
}
|
|
917
|
-
function
|
|
917
|
+
function Menu(props) {
|
|
918
918
|
if (isLegacy(props)) {
|
|
919
919
|
return React.createElement(MenuLegacy, Object.assign({}, props));
|
|
920
920
|
}
|
|
@@ -1011,25 +1011,23 @@ function MenuHeaderLabel(props) {
|
|
|
1011
1011
|
}
|
|
1012
1012
|
// Menu now routes the legacy items-based API locally and owns the new
|
|
1013
1013
|
// Base UI-backed composable implementation directly.
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
ItemSuffix: MenuItemSuffix,
|
|
1033
|
-
});
|
|
1014
|
+
Menu.Group = MenuGroup;
|
|
1015
|
+
Menu.GroupLabel = MenuGroupLabel;
|
|
1016
|
+
Menu.Section = MenuSection;
|
|
1017
|
+
Menu.Header = MenuHeader;
|
|
1018
|
+
Menu.HeaderLabel = MenuHeaderLabel;
|
|
1019
|
+
Menu.Item = MenuItem;
|
|
1020
|
+
Menu.Trigger = MenuTrigger;
|
|
1021
|
+
Menu.Content = MenuContent;
|
|
1022
|
+
Menu.Separator = MenuSeparator;
|
|
1023
|
+
Menu.RadioGroup = MenuRadioGroup;
|
|
1024
|
+
Menu.RadioItem = MenuRadioItem;
|
|
1025
|
+
Menu.Submenu = MenuSubmenu;
|
|
1026
|
+
Menu.SubmenuTrigger = MenuSubmenuTrigger;
|
|
1027
|
+
Menu.SubmenuContent = MenuSubmenuContent;
|
|
1028
|
+
Menu.ItemIcon = MenuItemIcon;
|
|
1029
|
+
Menu.ItemLabel = MenuItemLabel;
|
|
1030
|
+
Menu.ItemPrefix = MenuItemPrefix;
|
|
1031
|
+
Menu.ItemSuffix = MenuItemSuffix;
|
|
1034
1032
|
|
|
1035
1033
|
exports.Menu = Menu;
|
package/dist/Menu-es.js
CHANGED
|
@@ -13,7 +13,7 @@ import { _ as __rest } from './tslib.es6-es.js';
|
|
|
13
13
|
import { m as mergeProps } from './useRenderElement-es.js';
|
|
14
14
|
import { B as BottomSheet } from './BottomSheet-es.js';
|
|
15
15
|
import { O as OverlaySeparator } from './OverlaySeparator-es.js';
|
|
16
|
-
import { D as DrawerTrigger, a as DrawerTitle, b as DrawerClose, M as MenuTrigger$1, c as MenuLinkItem, d as MenuItem$1, e as MenuRadioItem$1, f as MenuRadioItemIndicator, g as MenuSubmenuTrigger$1, h as MenuRoot
|
|
16
|
+
import { D as DrawerTrigger, a as DrawerTitle, b as DrawerClose, M as MenuTrigger$1, c as MenuLinkItem, d as MenuItem$1, e as MenuRadioItem$1, f as MenuRadioItemIndicator, g as MenuSubmenuTrigger$1, h as MenuRoot, i as MenuPortal$1, j as MenuPositioner, k as MenuPopup, l as MenuRadioGroup$1, m as MenuGroup$1, n as MenuSubmenuRoot, o as MenuGroupLabel$1 } from './MenuSubmenuTrigger-es.js';
|
|
17
17
|
|
|
18
18
|
var styles$2 = {"wrapper":"h-nk89U2n6Q-","floatingContainer":"krpkWzoaVcc-","menu":"_7sU7mp1w0jM-","legacySection":"_4x-vvEmn4gM-","separator":"i0QNcs4S-wk-","triggerWrapper":"_7CsejipGrzM-","ariaMenu":"bO7lGVQC42c-","ariaItem":"u6fDgbWmPck-","ariaSection":"-TSNrZBKZJI-","ariaSectionHeader":"zs7dS2pKjEw-","sectionHeader":"MZJgunQcmdQ-","legacyAction":"_-1GOlrzd098-","action":"NYXV5w4pd0c-","destructive":"baYK2zQ6-GA-","overlay":"A7T14ALVEKg-","fullWidth":"Lgbn9IRPI5Y-","screenReaderOnly":"o-ps580KdWI-","spinning":"f1oTdSTeUOM-"};
|
|
19
19
|
|
|
@@ -743,7 +743,7 @@ function MenuDropdownRoot({ children, onOpenChange, open, defaultOpen, }) {
|
|
|
743
743
|
(_a = actionsRef.current) === null || _a === void 0 ? void 0 : _a.close();
|
|
744
744
|
},
|
|
745
745
|
} },
|
|
746
|
-
React__default.createElement(MenuRoot
|
|
746
|
+
React__default.createElement(MenuRoot, { actionsRef: actionsRef, open: open, defaultOpen: defaultOpen, onOpenChange: isOpen => {
|
|
747
747
|
onOpenChange === null || onOpenChange === void 0 ? void 0 : onOpenChange(isOpen);
|
|
748
748
|
} }, children)));
|
|
749
749
|
}
|
|
@@ -912,7 +912,7 @@ function MenuComposableRoot(props) {
|
|
|
912
912
|
return (React__default.createElement(MenuContext.Provider, { value: { isMobile } },
|
|
913
913
|
React__default.createElement(RootComponent, { onOpenChange: props.onOpenChange, open: props.open, defaultOpen: props.defaultOpen }, props.children)));
|
|
914
914
|
}
|
|
915
|
-
function
|
|
915
|
+
function Menu(props) {
|
|
916
916
|
if (isLegacy(props)) {
|
|
917
917
|
return React__default.createElement(MenuLegacy, Object.assign({}, props));
|
|
918
918
|
}
|
|
@@ -1009,25 +1009,23 @@ function MenuHeaderLabel(props) {
|
|
|
1009
1009
|
}
|
|
1010
1010
|
// Menu now routes the legacy items-based API locally and owns the new
|
|
1011
1011
|
// Base UI-backed composable implementation directly.
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
ItemSuffix: MenuItemSuffix,
|
|
1031
|
-
});
|
|
1012
|
+
Menu.Group = MenuGroup;
|
|
1013
|
+
Menu.GroupLabel = MenuGroupLabel;
|
|
1014
|
+
Menu.Section = MenuSection;
|
|
1015
|
+
Menu.Header = MenuHeader;
|
|
1016
|
+
Menu.HeaderLabel = MenuHeaderLabel;
|
|
1017
|
+
Menu.Item = MenuItem;
|
|
1018
|
+
Menu.Trigger = MenuTrigger;
|
|
1019
|
+
Menu.Content = MenuContent;
|
|
1020
|
+
Menu.Separator = MenuSeparator;
|
|
1021
|
+
Menu.RadioGroup = MenuRadioGroup;
|
|
1022
|
+
Menu.RadioItem = MenuRadioItem;
|
|
1023
|
+
Menu.Submenu = MenuSubmenu;
|
|
1024
|
+
Menu.SubmenuTrigger = MenuSubmenuTrigger;
|
|
1025
|
+
Menu.SubmenuContent = MenuSubmenuContent;
|
|
1026
|
+
Menu.ItemIcon = MenuItemIcon;
|
|
1027
|
+
Menu.ItemLabel = MenuItemLabel;
|
|
1028
|
+
Menu.ItemPrefix = MenuItemPrefix;
|
|
1029
|
+
Menu.ItemSuffix = MenuItemSuffix;
|
|
1032
1030
|
|
|
1033
1031
|
export { Menu as M };
|
|
@@ -71,4 +71,4 @@ example.
|
|
|
71
71
|
| Prop | Type | Required | Default | Description |
|
|
72
72
|
|------|------|----------|---------|-------------|
|
|
73
73
|
| `initial` | `boolean` | No | — | Whether or not to animate the children on mount. By default it's set to false. |
|
|
74
|
-
| `transition` | `"
|
|
74
|
+
| `transition` | `"fade" | "fromBottom" | "fromLeft" | "fromLeftToRight" | "fromRight" | "fromRightToLeft" | "fromTop" | "popIn"` | No | — | The type of transition you can use. |
|
|
@@ -1323,7 +1323,7 @@ is, focus the extra element and if not it will focus the input.
|
|
|
1323
1323
|
| `onFocus` | `(event?: FocusEvent<Element, Element>) => void` | No | — | Focus callback. |
|
|
1324
1324
|
| `prefix` | `Affix` | No | — | Adds a prefix label and icon to the field |
|
|
1325
1325
|
| `ref` | `Ref<InputTextRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
1326
|
-
| `size` | `"
|
|
1326
|
+
| `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
|
|
1327
1327
|
| `suffix` | `{ onClick: () => void; readonly ariaLabel: string; readonly icon: IconNames; readonly label?: string; } | { onClick?: never; ariaLabel?: never; readonly label?: string; readonly icon?: IconNames; }` | No | — | Adds a suffix label and icon with an optional action to the field |
|
|
1328
1328
|
| `validations` | `RegisterOptions` | No | — | Validations to run on the input. |
|
|
1329
1329
|
| `version` | `1` | No | `1` | Version of the component to use. |
|
|
@@ -811,7 +811,7 @@ This is not yet implemented fully. Avoid using.
|
|
|
811
811
|
| `prefix` | `Affix` | No | — | Adds a prefix label and icon to the field. |
|
|
812
812
|
| `readOnly` | `boolean` | No | — | Whether the input is read-only (HTML standard casing). |
|
|
813
813
|
| `ref` | `Ref<HTMLInputElement | HTMLTextAreaElement>` | No | — | |
|
|
814
|
-
| `size` | `"
|
|
814
|
+
| `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
|
|
815
815
|
| `suffix` | `{ onClick: () => void; readonly ariaLabel: string; readonly icon: IconNames; readonly label?: string; } | { onClick?: never; ariaLabel?: never; readonly label?: string; readonly icon?: IconNames; }` | No | — | Adds a suffix label and icon with an optional action to the field. |
|
|
816
816
|
| `UNSAFE_className` | `{ menu?: string; option?: string; section?: string; action?: string; input?: string; header?: string; footer?: string; selection?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
817
817
|
| `UNSAFE_styles` | `{ menu?: CSSProperties; option?: CSSProperties; section?: CSSProperties; action?: CSSProperties; input?: CSSProperties; header?: CSSProperties; footer?: CSSProperties; selection?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
@@ -391,47 +391,6 @@ Use `UNSAFE_style` to apply inline custom styles to the Banner.
|
|
|
391
391
|
| `onDismiss` | `() => void` | No | — | Callback to be called when the Banner is dismissed. |
|
|
392
392
|
| `primaryAction` | `{ onClick?: never; external?: never; readonly name?: string; submit: never; readonly type?: ButtonType; readonly value?: string; readonly size?: ButtonSize; readonly ariaLabel?: string; ... 17 more ...; readonly children?: never; } | ... 34 more ... | { ...; }` | No | — | Accepts props for Button. Default action uses a 'subtle' Button |
|
|
393
393
|
|
|
394
|
-
#### Banner.Provider
|
|
395
|
-
|
|
396
|
-
| Prop | Type | Required | Default | Description |
|
|
397
|
-
|------|------|----------|---------|-------------|
|
|
398
|
-
| `type` | `BannerType` | Yes | — | Sets the status-based theme of the Banner. |
|
|
399
|
-
| `dismissButton` | `ReactNode` | No | `<Banner.DismissButton/>` | Dismiss button to be used for the Banner. If you want to remove the dismiss button, set to false. |
|
|
400
|
-
| `icon` | `ReactNode` | No | `<Banner.Icon/>` | Icon to be used for the Banner. If you want to remove the icon, set to false. |
|
|
401
|
-
| `onDismiss` | `() => void` | No | — | Callback to be called when the Banner is dismissed. |
|
|
402
|
-
| `UNSAFE_className` | `{ readonly container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
403
|
-
| `UNSAFE_style` | `{ readonly container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
404
|
-
| `visible` | `boolean` | No | — | When provided, Banner's visibility is controlled by this value. |
|
|
405
|
-
|
|
406
|
-
#### Banner.Icon
|
|
407
|
-
|
|
408
|
-
| Prop | Type | Required | Default | Description |
|
|
409
|
-
|------|------|----------|---------|-------------|
|
|
410
|
-
| `backgroundColor` | `"event" | "invoice" | "job" | "quote" | "request" | "task" | "text" | "visit" | "warning" | "icon" | "disabled" | "success" | "base-grey--100" | "base-grey--200" | "base-grey--300" | ... 269 more ... | "client--onSurface"` | No | — | Sets the background color of the icon. |
|
|
411
|
-
| `color` | `"task" | "text" | "warning" | "icon" | "disabled" | "success" | "blue" | "green" | "yellow" | "red" | "grey" | "white" | "greyBlue" | "lightBlue" | "orange" | "navy" | "interactive" | ... 32 more ... | "brandHighlight"` | No | — | Determines the color of the icon. Some icons have a default system colour like quotes, jobs, and invoices. Others tha... |
|
|
412
|
-
| `customColor` | `string` | No | — | Sets a custom color for the icon. Can be a rgb() or hex value. |
|
|
413
|
-
| `name` | `IconNames` | No | — | The icon to show. |
|
|
414
|
-
| `size` | `"small" | "large" | "base"` | No | `base` | Changes the size to small or large. |
|
|
415
|
-
| `testID` | `string` | No | — | Used to locate this view in end-to-end tests |
|
|
416
|
-
| `UNSAFE_className` | `{ readonly container?: string; readonly icon?: { svg?: string; path?: string; }; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
417
|
-
| `UNSAFE_style` | `{ readonly container?: CSSProperties; readonly icon?: { svg?: CSSProperties; path?: CSSProperties; }; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
418
|
-
|
|
419
|
-
#### Banner.Content
|
|
420
|
-
|
|
421
|
-
| Prop | Type | Required | Default | Description |
|
|
422
|
-
|------|------|----------|---------|-------------|
|
|
423
|
-
| `UNSAFE_className` | `{ readonly container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
424
|
-
| `UNSAFE_style` | `{ readonly container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
425
|
-
|
|
426
|
-
#### Banner.DismissButton
|
|
427
|
-
|
|
428
|
-
| Prop | Type | Required | Default | Description |
|
|
429
|
-
|------|------|----------|---------|-------------|
|
|
430
|
-
| `ariaLabel` | `string` | No | — | |
|
|
431
|
-
| `onClick` | `(event: MouseEvent<HTMLAnchorElement | HTMLButtonElement, MouseEvent>) => void` | No | — | |
|
|
432
|
-
| `UNSAFE_className` | `{ readonly container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
433
|
-
| `UNSAFE_style` | `{ readonly container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
434
|
-
|
|
435
394
|
#### Banner.Action
|
|
436
395
|
|
|
437
396
|
| Prop | Type | Required | Default | Description |
|
|
@@ -461,3 +420,44 @@ Use `UNSAFE_style` to apply inline custom styles to the Banner.
|
|
|
461
420
|
| `url` | `string` | No | — | Used to create an 'href' on an anchor tag. |
|
|
462
421
|
| `value` | `string` | No | — | |
|
|
463
422
|
| `variation` | `ButtonVariation` | No | — | |
|
|
423
|
+
|
|
424
|
+
#### Banner.Content
|
|
425
|
+
|
|
426
|
+
| Prop | Type | Required | Default | Description |
|
|
427
|
+
|------|------|----------|---------|-------------|
|
|
428
|
+
| `UNSAFE_className` | `{ readonly container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
429
|
+
| `UNSAFE_style` | `{ readonly container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
430
|
+
|
|
431
|
+
#### Banner.DismissButton
|
|
432
|
+
|
|
433
|
+
| Prop | Type | Required | Default | Description |
|
|
434
|
+
|------|------|----------|---------|-------------|
|
|
435
|
+
| `ariaLabel` | `string` | No | — | |
|
|
436
|
+
| `onClick` | `(event: MouseEvent<HTMLAnchorElement | HTMLButtonElement, MouseEvent>) => void` | No | — | |
|
|
437
|
+
| `UNSAFE_className` | `{ readonly container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
438
|
+
| `UNSAFE_style` | `{ readonly container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
439
|
+
|
|
440
|
+
#### Banner.Icon
|
|
441
|
+
|
|
442
|
+
| Prop | Type | Required | Default | Description |
|
|
443
|
+
|------|------|----------|---------|-------------|
|
|
444
|
+
| `backgroundColor` | `"event" | "invoice" | "job" | "quote" | "request" | "task" | "text" | "visit" | "warning" | "icon" | "disabled" | "success" | "base-grey--100" | "base-grey--200" | "base-grey--300" | ... 269 more ... | "client--onSurface"` | No | — | Sets the background color of the icon. |
|
|
445
|
+
| `color` | `"task" | "text" | "warning" | "icon" | "disabled" | "success" | "blue" | "green" | "yellow" | "red" | "grey" | "white" | "greyBlue" | "lightBlue" | "orange" | "navy" | "interactive" | ... 32 more ... | "brandHighlight"` | No | — | Determines the color of the icon. Some icons have a default system colour like quotes, jobs, and invoices. Others tha... |
|
|
446
|
+
| `customColor` | `string` | No | — | Sets a custom color for the icon. Can be a rgb() or hex value. |
|
|
447
|
+
| `name` | `IconNames` | No | — | The icon to show. |
|
|
448
|
+
| `size` | `"base" | "large" | "small"` | No | `base` | Changes the size to small or large. |
|
|
449
|
+
| `testID` | `string` | No | — | Used to locate this view in end-to-end tests |
|
|
450
|
+
| `UNSAFE_className` | `{ readonly container?: string; readonly icon?: { svg?: string; path?: string; }; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
451
|
+
| `UNSAFE_style` | `{ readonly container?: CSSProperties; readonly icon?: { svg?: CSSProperties; path?: CSSProperties; }; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
452
|
+
|
|
453
|
+
#### Banner.Provider
|
|
454
|
+
|
|
455
|
+
| Prop | Type | Required | Default | Description |
|
|
456
|
+
|------|------|----------|---------|-------------|
|
|
457
|
+
| `type` | `BannerType` | Yes | — | Sets the status-based theme of the Banner. |
|
|
458
|
+
| `dismissButton` | `ReactNode` | No | `<Banner.DismissButton/>` | Dismiss button to be used for the Banner. If you want to remove the dismiss button, set to false. |
|
|
459
|
+
| `icon` | `ReactNode` | No | `<Banner.Icon/>` | Icon to be used for the Banner. If you want to remove the icon, set to false. |
|
|
460
|
+
| `onDismiss` | `() => void` | No | — | Callback to be called when the Banner is dismissed. |
|
|
461
|
+
| `UNSAFE_className` | `{ readonly container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
462
|
+
| `UNSAFE_style` | `{ readonly container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
463
|
+
| `visible` | `boolean` | No | — | When provided, Banner's visibility is controlled by this value. |
|
package/dist/docs/Box/Box.md
CHANGED
|
@@ -205,19 +205,19 @@ defaults to respecting theme/modes.
|
|
|
205
205
|
|------|------|----------|---------|-------------|
|
|
206
206
|
| `alignItems` | `AlignItems` | No | — | This feature is well established and works across many devices and browser versions. It’s been available across brows... |
|
|
207
207
|
| `alignSelf` | `AlignSelf` | No | — | This feature is well established and works across many devices and browser versions. It’s been available across brows... |
|
|
208
|
-
| `as` | `"
|
|
208
|
+
| `as` | `"article" | "aside" | "div" | "main" | "section" | "span"` | No | `div` | |
|
|
209
209
|
| `background` | `"event" | "invoice" | "job" | "quote" | "request" | "task" | "text" | "visit" | "warning" | "icon" | "disabled" | "success" | "base-grey--100" | "base-grey--200" | "base-grey--300" | ... 269 more ... | "client--onSurface"` | No | — | |
|
|
210
210
|
| `border` | `"base" | "thick" | "thicker" | "thickest" | BoxBorderWidth` | No | — | |
|
|
211
211
|
| `borderColor` | `"event" | "invoice" | "job" | "quote" | "request" | "task" | "text" | "visit" | "warning" | "icon" | "disabled" | "success" | "base-grey--100" | "base-grey--200" | "base-grey--300" | ... 269 more ... | "client--onSurface"` | No | — | |
|
|
212
212
|
| `direction` | `FlexDirection` | No | — | |
|
|
213
|
-
| `gap` | `"
|
|
213
|
+
| `gap` | `"base" | "extravagant" | "large" | "larger" | "largest" | "minuscule" | "slim" | "small" | "smaller" | "smallest"` | No | — | |
|
|
214
214
|
| `height` | `BoxDimension` | No | `auto` | |
|
|
215
215
|
| `justifyContent` | `JustifyContent` | No | — | This feature is well established and works across many devices and browser versions. It’s been available across brows... |
|
|
216
|
-
| `margin` | `"
|
|
216
|
+
| `margin` | `"base" | "extravagant" | "large" | "larger" | "largest" | "minuscule" | "slim" | "small" | "smaller" | "smallest" | BoxSpace` | No | — | |
|
|
217
217
|
| `overflow` | `Overflow` | No | — | This feature is well established and works across many devices and browser versions. It’s been available across brows... |
|
|
218
|
-
| `padding` | `"
|
|
218
|
+
| `padding` | `"base" | "extravagant" | "large" | "larger" | "largest" | "minuscule" | "slim" | "small" | "smaller" | "smallest" | BoxSpace` | No | — | |
|
|
219
219
|
| `position` | `Position` | No | `relative` | This feature is well established and works across many devices and browser versions. It’s been available across brows... |
|
|
220
220
|
| `preserveWhiteSpace` | `boolean` | No | — | |
|
|
221
|
-
| `radius` | `"
|
|
221
|
+
| `radius` | `"base" | "circle" | "large" | "larger" | "small"` | No | — | |
|
|
222
222
|
| `tabIndex` | `number` | No | — | [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex) |
|
|
223
223
|
| `width` | `BoxDimension` | No | `auto` | |
|
|
@@ -930,29 +930,29 @@ export const styles = StyleSheet.create({
|
|
|
930
930
|
| `value` | `string` | No | — | |
|
|
931
931
|
| `variation` | `ButtonVariation` | No | — | |
|
|
932
932
|
|
|
933
|
+
#### Button.Icon
|
|
934
|
+
|
|
935
|
+
| Prop | Type | Required | Default | Description |
|
|
936
|
+
|------|------|----------|---------|-------------|
|
|
937
|
+
| `name` | `IconNames` | Yes | — | The icon to show. |
|
|
938
|
+
| `size` | `"base" | "large" | "small"` | No | `base` | Changes the size to small or large. |
|
|
939
|
+
| `testID` | `string` | No | — | Used to locate this view in end-to-end tests |
|
|
940
|
+
| `UNSAFE_className` | `{ svg?: string; path?: string; }` | No | — | **Use at your own risk:** Custom classnames for specific elements. This should only be used as a **last resort**. Usi... |
|
|
941
|
+
| `UNSAFE_style` | `{ svg?: CSSProperties; path?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
942
|
+
|
|
933
943
|
#### Button.Label
|
|
934
944
|
|
|
935
945
|
| Prop | Type | Required | Default | Description |
|
|
936
946
|
|------|------|----------|---------|-------------|
|
|
937
947
|
| `align` | `"center" | "end" | "start"` | No | `"start"` | Sets the alignment to start, center, or end. In LTR scripts this equates to left, center, or right. |
|
|
938
|
-
| `element` | `"
|
|
948
|
+
| `element` | `"b" | "dd" | "dt" | "em" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p" | "span" | "strong"` | No | `span` | |
|
|
939
949
|
| `emphasisType` | `"highlight" | "italic"` | No | — | |
|
|
940
950
|
| `fontFamily` | `"base" | "display"` | No | `base` | |
|
|
941
951
|
| `fontWeight` | `"black" | "bold" | "extraBold" | "medium" | "regular" | "semiBold"` | No | `semiBold` | Aside from changing the font weights, this also changes the font family. Source sans for `regular` and `bold`. Poppin... |
|
|
942
952
|
| `id` | `string` | No | — | |
|
|
943
953
|
| `numberOfLines` | `number` | No | — | |
|
|
944
|
-
| `size` | `"
|
|
945
|
-
| `textCase` | `"
|
|
954
|
+
| `size` | `"base" | "extravagant" | "jumbo" | "large" | "larger" | "largest" | "small" | "smaller"` | No | — | |
|
|
955
|
+
| `textCase` | `"capitalize" | "lowercase" | "none" | "uppercase"` | No | — | |
|
|
946
956
|
| `underline` | `UnderlineStyle | "solid color-indigo" | "solid color-indigo--light" | "solid color-indigo--lighter" | "solid color-indigo--lightest" | "solid color-indigo--dark" | ... 646 more ... | "dashed color-client--onSurface"` | No | — | The style (and optionally a color) of underline the text is decorated with. All semantic color tokens (other than the... |
|
|
947
957
|
| `UNSAFE_className` | `{ textStyle?: string; }` | No | — | **Use at your own risk:** Custom classNames for specific elements. This should only be used as a **last resort**. Usi... |
|
|
948
958
|
| `UNSAFE_style` | `{ textStyle?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
949
|
-
|
|
950
|
-
#### Button.Icon
|
|
951
|
-
|
|
952
|
-
| Prop | Type | Required | Default | Description |
|
|
953
|
-
|------|------|----------|---------|-------------|
|
|
954
|
-
| `name` | `IconNames` | Yes | — | The icon to show. |
|
|
955
|
-
| `size` | `"small" | "large" | "base"` | No | `base` | Changes the size to small or large. |
|
|
956
|
-
| `testID` | `string` | No | — | Used to locate this view in end-to-end tests |
|
|
957
|
-
| `UNSAFE_className` | `{ svg?: string; path?: string; }` | No | — | **Use at your own risk:** Custom classnames for specific elements. This should only be used as a **last resort**. Usi... |
|
|
958
|
-
| `UNSAFE_style` | `{ svg?: CSSProperties; path?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
@@ -59,7 +59,7 @@ able to keep track the state of the child Checkboxes. See
|
|
|
59
59
|
| Prop | Type | Required | Default | Description |
|
|
60
60
|
|------|------|----------|---------|-------------|
|
|
61
61
|
| `aria-activedescendant` | `string` | No | — | ID of the currently active descendant element. Used for composite widgets like combobox or listbox. @see {@link https... |
|
|
62
|
-
| `aria-autocomplete` | `"
|
|
62
|
+
| `aria-autocomplete` | `"both" | "inline" | "list" | "none"` | No | — | Indicates the type of autocomplete interaction. @see {@link https://www.w3.org/TR/wai-aria-1.2/#aria-autocomplete} |
|
|
63
63
|
| `aria-controls` | `string` | No | — | Indicates the element that controls the current element. @see {@link https://www.w3.org/TR/wai-aria-1.2/#aria-controls} |
|
|
64
64
|
| `aria-describedby` | `string` | No | — | Identifies the element (or elements) that describes the object. @see {@link https://www.w3.org/TR/wai-aria-1.2/#aria-... |
|
|
65
65
|
| `aria-details` | `string` | No | — | Identifies the element (or elements) that provide a detailed, extended description. @see {@link https://www.w3.org/TR... |
|
|
@@ -84,5 +84,5 @@ able to keep track the state of the child Checkboxes. See
|
|
|
84
84
|
| `onMouseUp` | `(event: MouseEvent<HTMLInputElement, MouseEvent>) => void` | No | — | Mouse up event handler. |
|
|
85
85
|
| `onPointerDown` | `(event: PointerEvent<HTMLInputElement>) => void` | No | — | Pointer down event handler. |
|
|
86
86
|
| `onPointerUp` | `(event: PointerEvent<HTMLInputElement>) => void` | No | — | Pointer up event handler. |
|
|
87
|
-
| `ref` | `Ref<
|
|
87
|
+
| `ref` | `Ref<HTMLInputElement>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
88
88
|
| `value` | `string` | No | — | Value of the checkbox. |
|
package/dist/docs/Chip/Chip.md
CHANGED
|
@@ -369,9 +369,9 @@ those more complex selection flows.
|
|
|
369
369
|
| `onClick` | `((ev: MouseEvent<HTMLButtonElement | HTMLDivElement, MouseEvent>) => void) & MouseEventHandler<ChipElement>` | No | — | Chip click callback using a standard event-first signature. |
|
|
370
370
|
| `onClickValue` | `(value: string | number, ev: MouseEvent<HTMLButtonElement | HTMLDivElement, MouseEvent>) => void` | No | — | Value-first click callback retained as an upgrade path for existing consumers. @deprecated Prefer `onClick` with a cl... |
|
|
371
371
|
| `onKeyDown` | `((ev: KeyboardEvent<HTMLButtonElement | HTMLDivElement>) => void) & KeyboardEventHandler<ChipElement>` | No | — | Callback. Called when you keydown on Chip. Ships the event, so you can get the key pushed. |
|
|
372
|
-
| `ref` | `Ref<
|
|
372
|
+
| `ref` | `Ref<HTMLButtonElement | HTMLDivElement>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
373
373
|
| `role` | `string` | No | `button` | The accessible role the Chip is fulfilling. Defaults to 'button' |
|
|
374
374
|
| `tabIndex` | `number` | No | `0` | Used for accessibility purpopses, specifically using the tab key as navigation. |
|
|
375
375
|
| `testID` | `string` | No | — | The testing id for the chip if necessary. |
|
|
376
|
-
| `value` | `
|
|
376
|
+
| `value` | `number | string` | No | — | Will be passed to onClick, when the user clicks on this Chip. |
|
|
377
377
|
| `variation` | `ChipVariations` | No | `base` | Button style variation. Does not affect functionality. |
|
|
@@ -219,16 +219,16 @@ equal spacing and consistent sizing.
|
|
|
219
219
|
|
|
220
220
|
| Prop | Type | Required | Default | Description |
|
|
221
221
|
|------|------|----------|---------|-------------|
|
|
222
|
-
| `align` | `"
|
|
222
|
+
| `align` | `"center" | "end" | "start" | "stretch"` | No | — | The vertical alignment of the cluster elements. |
|
|
223
223
|
| `ariaAttributes` | `AriaAttributes` | No | — | Standard HTML aria attributes. Accepts all standard HTML aria attributes. |
|
|
224
224
|
| `as` | `CommonAllowedElements` | No | `div` | The HTML tag to render the cluster as. |
|
|
225
225
|
| `autoWidth` | `boolean` | No | `false` | Enabling this prevents the cluster from taking 100% of the width of the parent and instead flows with the content. |
|
|
226
|
-
| `collapseBelow` | `"
|
|
226
|
+
| `collapseBelow` | `"lg" | "md" | "sm" | "xl" | "xs"` | No | — | The breakpoint below which the cluster will collapse. |
|
|
227
227
|
| `collapsed` | `boolean` | No | — | Force the cluster to collapse. Use this when our breakpoints are not enough control. |
|
|
228
228
|
| `dataAttributes` | `{ [key: `data-${string}`]: string; }` | No | — | Standard HTML data attributes. Accepts anything in a {{"data-key":"value"}} format. |
|
|
229
229
|
| `gap` | `GapSpacing` | No | — | The amount of space between the cluster elements. Semantic tokens are available. |
|
|
230
230
|
| `id` | `string` | No | — | Standard HTML id attribute. |
|
|
231
|
-
| `justify` | `"
|
|
231
|
+
| `justify` | `"center" | "end" | "space-around" | "space-between" | "start"` | No | — | The horizontal justification of the cluster elements. |
|
|
232
232
|
| `role` | `AriaRole` | No | — | Standard HTML role attribute. |
|
|
233
233
|
| `UNSAFE_className` | `{ container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
234
234
|
| `UNSAFE_style` | `{ container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
@@ -275,7 +275,7 @@ window.HTMLElement.prototype.scrollIntoView = scrollIntoViewMock;
|
|
|
275
275
|
|
|
276
276
|
| Prop | Type | Required | Default | Description |
|
|
277
277
|
|------|------|----------|---------|-------------|
|
|
278
|
-
| `id` | `
|
|
278
|
+
| `id` | `number | string` | Yes | — | A unique identifier for the option. |
|
|
279
279
|
| `label` | `string` | Yes | — | The value to be visually displayed in the Combobox options list. |
|
|
280
280
|
| `customRender` | `(option: Pick<ComboboxOptionProps, "prefix" | "label" | "id"> & { isSelected: boolean; defaultContent: ReactElement<unknown, string | JSXElementConstructor<any>>; }) => ReactNode` | No | — | Advanced: A custom render prop to completely control how this option is rendered. The function receives the option's ... |
|
|
281
281
|
| `onClick` | `(option: ComboboxOptionProps) => void` | No | — | Callback function invoked when the option is clicked. |
|
|
@@ -119,7 +119,7 @@ language should be direct and honest about the impact without being alarming.
|
|
|
119
119
|
| `onConfirm` | `() => void` | No | — | Callback for when the confirm button is pressed. |
|
|
120
120
|
| `onRequestClose` | `() => void` | No | — | Callback for whenever a user's action should close the modal. |
|
|
121
121
|
| `open` | `boolean` | No | `false` | Controls if the modal is open or not. |
|
|
122
|
-
| `ref` | `Ref<
|
|
123
|
-
| `size` | `"
|
|
122
|
+
| `ref` | `Ref<ConfirmationModalRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
123
|
+
| `size` | `"large" | "small"` | No | — | Size of the modal (small, large), |
|
|
124
124
|
| `title` | `string` | No | — | Title for the modal. |
|
|
125
|
-
| `variation` | `"
|
|
125
|
+
| `variation` | `"destructive" | "work"` | No | `work` | Type (Work or destructive) for confirm button. |
|
|
@@ -60,5 +60,5 @@ UNSAFE_style: {
|
|
|
60
60
|
|
|
61
61
|
| Prop | Type | Required | Default | Description |
|
|
62
62
|
|------|------|----------|---------|-------------|
|
|
63
|
-
| `spacing` | `"
|
|
64
|
-
| `type` | `"
|
|
63
|
+
| `spacing` | `"base" | "extravagant" | "large" | "larger" | "largest" | "minuscule" | "slim" | "small" | "smaller" | "smallest"` | No | `base` | The amount of vertical spacing between the children |
|
|
64
|
+
| `type` | `"article" | "aside" | "div" | "footer" | "header" | "main" | "section"` | No | `div` | Change the wrapping element to be one of the available semantic tags. |
|
|
@@ -42,7 +42,7 @@ decision on whether to show or hide the units.
|
|
|
42
42
|
|
|
43
43
|
| Prop | Type | Required | Default | Description |
|
|
44
44
|
|------|------|----------|---------|-------------|
|
|
45
|
-
| `date` | `
|
|
45
|
+
| `date` | `Date | number | string` | Yes | — | The date that is being counted down to. Value for date as a `string` should be in ISO 8601 format. |
|
|
46
46
|
| `granularity` | `GranularityOptions` | No | `dhms` | Defines the time format presented (e.g., dhms will show days, hours, minutes, and seconds) |
|
|
47
47
|
| `onComplete` | `() => void` | No | — | Callback when the countdown is done |
|
|
48
48
|
| `showUnits` | `boolean` | No | — | Whether or not to present the unit of time to the user, or just the raw numbers. |
|
|
@@ -520,7 +520,7 @@ objects that will define the sorting options for the column.
|
|
|
520
520
|
| `headers` | `DataListHeader<T>` | Yes | — | The header of the DataList. The object keys are determined by the keys in the data. |
|
|
521
521
|
| `filtered` | `boolean` | No | — | Adjusts the DataList to show the UX when it is filtered. |
|
|
522
522
|
| `headerVisibility` | `{ xs?: boolean; sm?: boolean; md?: boolean; lg?: boolean; xl?: boolean; }` | No | `{ xs: true, sm: true, md: true, lg: true, xl: true }` | Determine if the header is visible at a given breakpoint. If one isn't provided, it will use the value from the next ... |
|
|
523
|
-
| `loadingState` | `"
|
|
523
|
+
| `loadingState` | `"filtering" | "initial" | "loadingMore" | "none"` | No | — | Set the loading state of the DataList. There are a few guidelines on when to use what. - `"initial"` - loading the f... |
|
|
524
524
|
| `onLoadMore` | `() => void` | No | — | The callback function when the user scrolls to the bottom of the list. |
|
|
525
525
|
| `onSelect` | `(selected: DataListSelectedType<T["id"]>) => void` | No | — | Callback when an item checkbox is clicked. |
|
|
526
526
|
| `onSelectAll` | `(selected: DataListSelectedType<T["id"]>) => void` | No | — | Callback when the select all checkbox is clicked. |
|
|
@@ -529,23 +529,31 @@ objects that will define the sorting options for the column.
|
|
|
529
529
|
| `title` | `string` | No | — | The title of the DataList. |
|
|
530
530
|
| `totalCount` | `number` | No | — | Total number of items in the DataList. This renders an "N results" text with the DataList that helps users know how ... |
|
|
531
531
|
|
|
532
|
-
#### DataList.
|
|
532
|
+
#### DataList.BatchAction
|
|
533
533
|
|
|
534
534
|
| Prop | Type | Required | Default | Description |
|
|
535
535
|
|------|------|----------|---------|-------------|
|
|
536
|
-
| `
|
|
537
|
-
| `
|
|
538
|
-
| `
|
|
539
|
-
| `
|
|
536
|
+
| `label` | `string | ((item: DataListObject) => string)` | Yes | — | The label of the action |
|
|
537
|
+
| `actionUrl` | `string` | No | — | The URL to navigate to when the action is clicked. |
|
|
538
|
+
| `alwaysVisible` | `boolean` | No | — | Determine if the action is always visible. It is not recommended to set this to true on more then one action. |
|
|
539
|
+
| `destructive` | `boolean` | No | — | Adjust the styling of an action label and icon to be more destructive. |
|
|
540
|
+
| `icon` | `IconNames` | No | — | The icon beside the label |
|
|
541
|
+
| `onClick` | `() => void` | No | — | The callback function when the action is clicked. |
|
|
540
542
|
|
|
541
|
-
#### DataList.
|
|
543
|
+
#### DataList.BatchActions
|
|
542
544
|
|
|
543
545
|
| Prop | Type | Required | Default | Description |
|
|
544
546
|
|------|------|----------|---------|-------------|
|
|
545
|
-
| `
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
547
|
+
| `children` | `Fragment<ReactElement<DataListBulkActionProps, string | JSXElementConstructor<any>>>` | No | — | The actions to render on the top of the DataList to make actions to multiple items. This only accepts the DataList.Ba... |
|
|
548
|
+
|
|
549
|
+
#### DataList.EmptyState
|
|
550
|
+
|
|
551
|
+
| Prop | Type | Required | Default | Description |
|
|
552
|
+
|------|------|----------|---------|-------------|
|
|
553
|
+
| `message` | `string` | Yes | — | The message that shows when the DataList is empty. |
|
|
554
|
+
| `action` | `ReactElement<{ onClick?: never; external?: never; readonly name?: string; submit: never; readonly type?: ButtonType; readonly value?: string; readonly size?: ButtonSize; readonly ariaLabel?: string; ... 17 more ...; readonly children?: never; } | ... 34 more ... | { ...; }, string | JSXElementConstructor<...>>` | No | — | The action that shows when the DataList is empty. This only accepts a Button component. Adding a non-Button componen... |
|
|
555
|
+
| `customRender` | `(emptyState: Omit<DataListEmptyStateProps, "customRender">) => ReactNode` | No | — | Custom render function for the empty state. If provided, this function will be used to render the empty state instea... |
|
|
556
|
+
| `type` | `"empty" | "filtered"` | No | — | Determine the type of empty state to show. By default, it will show the "empty" state when there is no data. If you ... |
|
|
549
557
|
|
|
550
558
|
#### DataList.ItemActions
|
|
551
559
|
|
|
@@ -557,19 +565,11 @@ objects that will define the sorting options for the column.
|
|
|
557
565
|
| `to` | `string | ((item: T) => string)` | No | — | If a React Navigation is needed, use this prop to use the `Link` component that comes with React Router. |
|
|
558
566
|
| `url` | `string | ((item: T) => string)` | No | — | If a normal page navigation is needed, use this prop to change the element to an `a` tag with an `href`. |
|
|
559
567
|
|
|
560
|
-
#### DataList.
|
|
561
|
-
|
|
562
|
-
| Prop | Type | Required | Default | Description |
|
|
563
|
-
|------|------|----------|---------|-------------|
|
|
564
|
-
| `children` | `Fragment<ReactElement<DataListBulkActionProps, string | JSXElementConstructor<any>>>` | No | — | The actions to render on the top of the DataList to make actions to multiple items. This only accepts the DataList.Ba... |
|
|
565
|
-
|
|
566
|
-
#### DataList.BatchAction
|
|
568
|
+
#### DataList.Search
|
|
567
569
|
|
|
568
570
|
| Prop | Type | Required | Default | Description |
|
|
569
571
|
|------|------|----------|---------|-------------|
|
|
570
|
-
| `
|
|
571
|
-
| `
|
|
572
|
-
| `
|
|
573
|
-
| `
|
|
574
|
-
| `icon` | `IconNames` | No | — | The icon beside the label |
|
|
575
|
-
| `onClick` | `() => void` | No | — | The callback function when the action is clicked. |
|
|
572
|
+
| `onSearch` | `(value: string) => void` | Yes | — | |
|
|
573
|
+
| `initialValue` | `string` | No | — | The initial value of the search input. Updating this prop after the component has mounted will rerender the componen... |
|
|
574
|
+
| `placeholder` | `string` | No | — | The placeholder text for the search input. This either uses the title prop prepended by "Search" or just falls back t... |
|
|
575
|
+
| `value` | `string` | No | — | The controlled value of the search input. Supply this field if you want to take control over the search input's valu... |
|
|
@@ -511,11 +511,14 @@ const table = useReactTable({
|
|
|
511
511
|
| `sorting` | `SortingType` | No | — | Enables sorting, mostly follows: https://tanstack.com/table/v8/docs/api/features/sorting#table-options |
|
|
512
512
|
| `stickyHeader` | `boolean` | No | — | When set to true makes the header sticky while scrolling vertically |
|
|
513
513
|
|
|
514
|
-
#### DataTable.
|
|
514
|
+
#### DataTable.PaginationButton
|
|
515
515
|
|
|
516
516
|
| Prop | Type | Required | Default | Description |
|
|
517
517
|
|------|------|----------|---------|-------------|
|
|
518
|
-
| `
|
|
518
|
+
| `ariaLabel` | `(direction: "next" | "previous") => string` | Yes | — | Function that returns the aria-label for the button. Required for accessibility. Should return translated strings bas... |
|
|
519
|
+
| `direction` | `"next" | "previous"` | Yes | — | The direction of the pagination button |
|
|
520
|
+
| `disabled` | `boolean` | No | `false` | Whether the pagination button is disabled |
|
|
521
|
+
| `onClick` | `() => void` | No | — | Callback function when the pagination button is clicked |
|
|
519
522
|
|
|
520
523
|
#### DataTable.RowActions
|
|
521
524
|
|
|
@@ -531,11 +534,8 @@ const table = useReactTable({
|
|
|
531
534
|
| `direction` | `SortDirection` | No | — | The current sort direction for this column. When undefined, the header renders as non-interactive. |
|
|
532
535
|
| `onSort` | `() => void` | No | — | Callback function triggered when the sortable header is clicked. When undefined, the header renders as non-interactive. |
|
|
533
536
|
|
|
534
|
-
#### DataTable.
|
|
537
|
+
#### DataTable.Table
|
|
535
538
|
|
|
536
539
|
| Prop | Type | Required | Default | Description |
|
|
537
540
|
|------|------|----------|---------|-------------|
|
|
538
|
-
| `
|
|
539
|
-
| `direction` | `"next" | "previous"` | Yes | — | The direction of the pagination button |
|
|
540
|
-
| `disabled` | `boolean` | No | `false` | Whether the pagination button is disabled |
|
|
541
|
-
| `onClick` | `() => void` | No | — | Callback function when the pagination button is clicked |
|
|
541
|
+
| `layout` | `"auto" | "fixed"` | No | — | Controls the table layout. - `auto` (default): Columns size to content. - `fixed`: Column widths can be set explicitl... |
|
|
@@ -80,7 +80,7 @@ through inline styles.
|
|
|
80
80
|
| Prop | Type | Required | Default | Description |
|
|
81
81
|
|------|------|----------|---------|-------------|
|
|
82
82
|
| `direction` | `"horizontal" | "vertical"` | No | `horizontal` | The direction of the divider |
|
|
83
|
-
| `size` | `"
|
|
83
|
+
| `size` | `"base" | "large" | "larger" | "largest"` | No | `base` | The weight of the divider. |
|
|
84
84
|
| `testID` | `string` | No | — | A reference to the element in the rendered output |
|
|
85
85
|
| `UNSAFE_className` | `{ readonly container?: string; }` | No | — | **Use at your own risk:** Custom classNames for specific elements. This should only be used as a **last resort**. Usi... |
|
|
86
86
|
| `UNSAFE_style` | `{ readonly container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
package/dist/docs/Flex/Flex.md
CHANGED
|
@@ -35,4 +35,4 @@ one-directional layout.
|
|
|
35
35
|
| `template` | `ColumnKeys[]` | Yes | — | Determine how the children gets laid out **Supported keys** - `"grow"` - Grows to the space available. If all childr... |
|
|
36
36
|
| `align` | `"center" | "end" | "start"` | No | `center` | Adjusts the alignment of the Flex children. |
|
|
37
37
|
| `direction` | `Direction` | No | `row` | The direction of the content. |
|
|
38
|
-
| `gap` | `"
|
|
38
|
+
| `gap` | `"base" | "extravagant" | "large" | "larger" | "largest" | "minuscule" | "none" | "slim" | "small" | "smaller" | "smallest"` | No | `base` | The spacing between the children. |
|