@jobber/components 7.11.1 → 7.11.3
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/Autocomplete/index.mjs +1 -1
- package/dist/Menu/Menu.d.ts +21 -1
- package/dist/Menu/menuComposableShared.d.ts +1 -4
- package/dist/Menu-cjs.js +63 -50
- package/dist/Menu-es.js +66 -53
- package/dist/Modal/index.mjs +1 -1
- 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/dist/floating-ui.react-es.js +1 -1
- package/dist/styles.css +16 -16
- package/dist/utils/mergeUnsafeProps.d.ts +8 -0
- package/package.json +2 -2
|
@@ -141,33 +141,33 @@ export function GlimmerSemanticBlocksExample() {
|
|
|
141
141
|
|------|------|----------|---------|-------------|
|
|
142
142
|
| `reverseTheme` | `boolean` | No | `false` | Use on surfaces with dark backgrounds. |
|
|
143
143
|
| `shape` | `"circle" | "rectangle" | "rectangleShort" | "rectangleShorter" | "square"` | No | `rectangle` | Sets the shape of the glimmer. If you need a specific width, use the `width` prop. |
|
|
144
|
-
| `size` | `"
|
|
144
|
+
| `size` | `"auto" | "base" | "large" | "larger" | "largest" | "small"` | No | `base` | Sets the size of the glimmer. If you use `"auto"` with a `"rectangle"` shape, it will fill the size of the parents w... |
|
|
145
145
|
| `timing` | `"base" | "fast"` | No | `base` | Control how fast the shine moves from left to right. This is useful when the glimmer is used on smaller spaces. |
|
|
146
146
|
| `width` | `number` | No | — | Adjust the width of the glimmer in px values. |
|
|
147
147
|
|
|
148
|
-
#### Glimmer.
|
|
148
|
+
#### Glimmer.Button
|
|
149
149
|
|
|
150
150
|
| Prop | Type | Required | Default | Description |
|
|
151
151
|
|------|------|----------|---------|-------------|
|
|
152
|
-
| `
|
|
152
|
+
| `fullWidth` | `boolean` | No | `false` | Allow `Glimmer.Button` to go full width. |
|
|
153
153
|
| `reverseTheme` | `boolean` | No | — | Use on surfaces with dark backgrounds. |
|
|
154
154
|
| `timing` | `"base" | "fast"` | No | — | Control how fast the shine moves from left to right. This is useful when the glimmer is used on smaller spaces. |
|
|
155
155
|
| `width` | `number` | No | — | Adjust the width of the glimmer in px values. |
|
|
156
156
|
|
|
157
|
-
#### Glimmer.
|
|
157
|
+
#### Glimmer.Header
|
|
158
158
|
|
|
159
159
|
| Prop | Type | Required | Default | Description |
|
|
160
160
|
|------|------|----------|---------|-------------|
|
|
161
|
-
| `
|
|
161
|
+
| `level` | `1 | 2 | 5 | 3 | 4` | No | `3` | Adjust the size of the `Glimmer.Header`. |
|
|
162
162
|
| `reverseTheme` | `boolean` | No | — | Use on surfaces with dark backgrounds. |
|
|
163
163
|
| `timing` | `"base" | "fast"` | No | — | Control how fast the shine moves from left to right. This is useful when the glimmer is used on smaller spaces. |
|
|
164
164
|
| `width` | `number` | No | — | Adjust the width of the glimmer in px values. |
|
|
165
165
|
|
|
166
|
-
#### Glimmer.
|
|
166
|
+
#### Glimmer.Text
|
|
167
167
|
|
|
168
168
|
| Prop | Type | Required | Default | Description |
|
|
169
169
|
|------|------|----------|---------|-------------|
|
|
170
|
-
| `
|
|
170
|
+
| `lines` | `1 | 2 | 3` | No | `3` | Set how many lines shows up. |
|
|
171
171
|
| `reverseTheme` | `boolean` | No | — | Use on surfaces with dark backgrounds. |
|
|
172
172
|
| `timing` | `"base" | "fast"` | No | — | Control how fast the shine moves from left to right. This is useful when the glimmer is used on smaller spaces. |
|
|
173
173
|
| `width` | `number` | No | — | Adjust the width of the glimmer in px values. |
|
package/dist/docs/Grid/Grid.md
CHANGED
|
@@ -67,8 +67,8 @@ instead.
|
|
|
67
67
|
| Prop | Type | Required | Default | Description |
|
|
68
68
|
|------|------|----------|---------|-------------|
|
|
69
69
|
| `children` | `ReactNode` | Yes | — | `Grid.Cell` children |
|
|
70
|
-
| `alignItems` | `"
|
|
71
|
-
| `gap` | `
|
|
70
|
+
| `alignItems` | `"center" | "end" | "start" | "stretch"` | No | `start` | Adjust the alignment of columns. We only support a few select properties from `align-items` due to the nature of the ... |
|
|
71
|
+
| `gap` | `GapSpacing | boolean` | No | `true` | Add spacing between elements. Can be a boolean for default spacing, or a semantic token for custom spacing. @deprecat... |
|
|
72
72
|
|
|
73
73
|
#### Grid.Cell
|
|
74
74
|
|
|
@@ -122,9 +122,9 @@ Use `UNSAFE_style` to apply inline custom styles to the Heading component.
|
|
|
122
122
|
|
|
123
123
|
| Prop | Type | Required | Default | Description |
|
|
124
124
|
|------|------|----------|---------|-------------|
|
|
125
|
-
| `element` | `"
|
|
125
|
+
| `element` | `"h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p" | "span"` | No | — | Allows overriding of the element rendered. Defaults to the heading specified with level. |
|
|
126
126
|
| `id` | `string` | No | — | Adds a unique identifier to the heading. Useful when the heading needs to be referenced by another element. Not inten... |
|
|
127
127
|
| `level` | `HeadingLevel` | No | `5` | |
|
|
128
|
-
| `maxLines` | `"
|
|
128
|
+
| `maxLines` | `"base" | "large" | "larger" | "single" | "small" | "unlimited"` | No | `unlimited` | The maximum amount of lines the text can occupy before being truncated with "...". Uses predefined string values that... |
|
|
129
129
|
| `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... |
|
|
130
130
|
| `UNSAFE_style` | `{ textStyle?: CSSProperties; }` | No | — | **Use at your own risk:** Custom styles for specific elements. This should only be used as a **last resort**. Using t... |
|
package/dist/docs/Icon/Icon.md
CHANGED
|
@@ -582,7 +582,7 @@ necessary.
|
|
|
582
582
|
| `name` | `IconNames` | Yes | — | The icon to show. |
|
|
583
583
|
| `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... |
|
|
584
584
|
| `customColor` | `string` | No | — | Sets a custom color for the icon. Can be a rgb() or hex value. |
|
|
585
|
-
| `size` | `"
|
|
585
|
+
| `size` | `"base" | "large" | "small"` | No | `base` | Changes the size to small or large. |
|
|
586
586
|
| `testID` | `string` | No | — | Used to locate this view in end-to-end tests |
|
|
587
587
|
| `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... |
|
|
588
588
|
| `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... |
|
|
@@ -141,4 +141,4 @@ export function InlineLabelSizesExample() {
|
|
|
141
141
|
| Prop | Type | Required | Default | Description |
|
|
142
142
|
|------|------|----------|---------|-------------|
|
|
143
143
|
| `color` | `InlineLabelColors` | No | `greyBlue` | The color of the label |
|
|
144
|
-
| `size` | `"
|
|
144
|
+
| `size` | `"base" | "large" | "larger" | "small"` | No | `base` | The size of the label |
|
|
@@ -116,7 +116,7 @@ at the root of the application, populated with the applicable value.
|
|
|
116
116
|
| `onChange` | `(newValue: Date, event?: ChangeEvent<HTMLInputElement>) => void` | Yes | — | Callback for value changes. @param newValue - The new Date value @param event - Optional change event |
|
|
117
117
|
| `align` | `"center" | "right"` | No | — | Determines the alignment of the text inside the input. |
|
|
118
118
|
| `aria-activedescendant` | `string` | No | — | ID of the currently active descendant element. Used for composite widgets like combobox or listbox. @see {@link https... |
|
|
119
|
-
| `aria-autocomplete` | `"
|
|
119
|
+
| `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} |
|
|
120
120
|
| `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} |
|
|
121
121
|
| `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-... |
|
|
122
122
|
| `aria-details` | `string` | No | — | Identifies the element (or elements) that provide a detailed, extended description. @see {@link https://www.w3.org/TR... |
|
|
@@ -132,7 +132,7 @@ at the root of the application, populated with the applicable value.
|
|
|
132
132
|
| `error` | `string` | No | — | Error message to display. This also highlights the field red. |
|
|
133
133
|
| `id` | `string` | No | — | The unique identifier for the input element. |
|
|
134
134
|
| `inline` | `boolean` | No | — | Adjusts the form field to go inline with content. |
|
|
135
|
-
| `inputMode` | `"
|
|
135
|
+
| `inputMode` | `"decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url"` | No | — | Input mode hint for virtual keyboards. |
|
|
136
136
|
| `invalid` | `boolean` | No | — | Highlights the field red to indicate an error. |
|
|
137
137
|
| `loading` | `boolean` | No | — | Show a spinner to indicate loading. |
|
|
138
138
|
| `maxDate` | `Date` | No | — | The maximum selectable date. |
|
|
@@ -146,10 +146,10 @@ at the root of the application, populated with the applicable value.
|
|
|
146
146
|
| `pattern` | `string` | No | — | Validation pattern (regex) for the input. |
|
|
147
147
|
| `placeholder` | `string` | No | — | Text that appears inside the input when empty and floats above the value as a mini label once the user enters a value... |
|
|
148
148
|
| `readOnly` | `boolean` | No | — | Whether the input is read-only (HTML standard casing). |
|
|
149
|
-
| `ref` | `Ref<
|
|
149
|
+
| `ref` | `Ref<HTMLInputElement>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
150
150
|
| `required` | `boolean` | No | — | Whether the input is required before form submission. |
|
|
151
151
|
| `role` | `string` | No | — | Role attribute for accessibility. |
|
|
152
152
|
| `showIcon` | `boolean` | No | `true` | Whether to show the calendar icon |
|
|
153
|
-
| `size` | `"
|
|
153
|
+
| `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
|
|
154
154
|
| `tabIndex` | `number` | No | — | Tab index for keyboard navigation. |
|
|
155
155
|
| `value` | `Date` | No | — | A Date object value (e.g., `new Date("11/11/2011")`) |
|
|
@@ -34,7 +34,7 @@ If you are not worried about email address validation, consider using
|
|
|
34
34
|
|------|------|----------|---------|-------------|
|
|
35
35
|
| `align` | `"center" | "right"` | No | — | Determines the alignment of the text inside the input. |
|
|
36
36
|
| `clearable` | `Clearable` | No | — | Add a clear action on the input that clears the value. You should always use `while-editing` if you want the input t... |
|
|
37
|
-
| `defaultValue` | `
|
|
37
|
+
| `defaultValue` | `Date | string` | No | — | Initial value of the input. Only use this when you need to pre-populate the field with a data that is not controlled ... |
|
|
38
38
|
| `description` | `ReactNode` | No | — | Further description of the input, can be used for a hint. |
|
|
39
39
|
| `disabled` | `boolean` | No | — | Disable the input |
|
|
40
40
|
| `id` | `string` | No | — | A unique identifier for the input. |
|
|
@@ -48,7 +48,7 @@ If you are not worried about email address validation, consider using
|
|
|
48
48
|
| `placeholder` | `string` | No | — | Text that appears inside the input when empty and floats above the value as a mini label once the user enters a value... |
|
|
49
49
|
| `readonly` | `boolean` | No | — | Prevents users from editing the value. |
|
|
50
50
|
| `showMiniLabel` | `boolean` | No | `true` | Controls the visibility of the mini label that appears inside the input when a value is entered. By default, the plac... |
|
|
51
|
-
| `size` | `"
|
|
51
|
+
| `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
|
|
52
52
|
| `validations` | `RegisterOptions` | No | — | Show an error message above the field. This also highlights the the field red if an error message shows up. |
|
|
53
|
-
| `value` | `
|
|
53
|
+
| `value` | `Date | number | string` | No | — | Set the component to the given value. |
|
|
54
54
|
| `version` | `1` | No | — | Experimental: Determine which version of the FormField to use. Right now this isn't used but it will be used in the f... |
|
|
@@ -371,7 +371,7 @@ function CustomUploadContent() {
|
|
|
371
371
|
| `onUploadError` | `(error: Error) => void` | No | — | Upload event handler. Triggered on upload error. |
|
|
372
372
|
| `onUploadProgress` | `(file: FileUpload) => void` | No | — | Upload event handler. Triggered as upload progresses. |
|
|
373
373
|
| `onUploadStart` | `(file: FileUpload) => void` | No | — | Upload event handler. Triggered on upload start. |
|
|
374
|
-
| `size` | `"
|
|
374
|
+
| `size` | `"base" | "small"` | No | `base` | Size of the InputFile |
|
|
375
375
|
| `validator` | `<T extends File>(file: T) => FileError | FileError[]` | No | — | Pass a custom validator function that will be called when a file is dropped. |
|
|
376
376
|
| `variation` | `"button" | "dropzone"` | No | `dropzone` | Display variation. |
|
|
377
377
|
|
|
@@ -406,11 +406,11 @@ function CustomUploadContent() {
|
|
|
406
406
|
|------|------|----------|---------|-------------|
|
|
407
407
|
| `align` | `"center" | "end" | "start"` | No | — | |
|
|
408
408
|
| `element` | `TextElement` | No | `"p"` | The HTML element to render the text as. |
|
|
409
|
-
| `maxLines` | `"
|
|
410
|
-
| `size` | `"
|
|
409
|
+
| `maxLines` | `"base" | "large" | "larger" | "single" | "small" | "unlimited"` | No | — | |
|
|
410
|
+
| `size` | `"base" | "large" | "small"` | No | `small` | |
|
|
411
411
|
| `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... |
|
|
412
412
|
| `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... |
|
|
413
|
-
| `variation` | `"
|
|
413
|
+
| `variation` | `"default" | "disabled" | "error" | "info" | "subdued" | "success" | "warn"` | No | `subdued` | |
|
|
414
414
|
|
|
415
415
|
#### InputFile.HintText
|
|
416
416
|
|
|
@@ -418,8 +418,8 @@ function CustomUploadContent() {
|
|
|
418
418
|
|------|------|----------|---------|-------------|
|
|
419
419
|
| `align` | `"center" | "end" | "start"` | No | — | |
|
|
420
420
|
| `element` | `TextElement` | No | `"p"` | The HTML element to render the text as. |
|
|
421
|
-
| `maxLines` | `"
|
|
422
|
-
| `size` | `"
|
|
421
|
+
| `maxLines` | `"base" | "large" | "larger" | "single" | "small" | "unlimited"` | No | — | |
|
|
422
|
+
| `size` | `"base" | "large" | "small"` | No | `small` | |
|
|
423
423
|
| `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... |
|
|
424
424
|
| `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... |
|
|
425
|
-
| `variation` | `"
|
|
425
|
+
| `variation` | `"default" | "disabled" | "error" | "info" | "subdued" | "success" | "warn"` | No | — | |
|
|
@@ -35,16 +35,16 @@ For more details about `validation` using `Input` components, see the
|
|
|
35
35
|
| Prop | Type | Required | Default | Description |
|
|
36
36
|
|------|------|----------|---------|-------------|
|
|
37
37
|
| `align` | `"center" | "right"` | No | — | Determines the alignment of the text inside the input. |
|
|
38
|
-
| `autocomplete` | `
|
|
38
|
+
| `autocomplete` | `AutocompleteTypes | boolean` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
|
|
39
39
|
| `clearable` | `Clearable` | No | — | Add a clear action on the input that clears the value. You should always use `while-editing` if you want the input t... |
|
|
40
|
-
| `defaultValue` | `
|
|
40
|
+
| `defaultValue` | `Date | string` | No | — | Initial value of the input. Only use this when you need to pre-populate the field with a data that is not controlled ... |
|
|
41
41
|
| `description` | `ReactNode` | No | — | Further description of the input, can be used for a hint. |
|
|
42
42
|
| `disabled` | `boolean` | No | — | Disable the input |
|
|
43
43
|
| `id` | `string` | No | — | A unique identifier for the input. |
|
|
44
44
|
| `inline` | `boolean` | No | — | Adjusts the form field to go inline with a content. This also silences the given `validations` prop. You'd have to us... |
|
|
45
45
|
| `inputRef` | `RefObject<HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement>` | No | — | |
|
|
46
46
|
| `invalid` | `boolean` | No | — | Highlights the field red to indicate an error. |
|
|
47
|
-
| `keyboard` | `"
|
|
47
|
+
| `keyboard` | `"decimal" | "numeric"` | No | — | Determines what kind of keyboard appears on mobile web. |
|
|
48
48
|
| `loading` | `boolean` | No | — | Show a spinner to indicate loading |
|
|
49
49
|
| `max` | `number` | No | — | Specifies the maximum numerical or date value that a user can type |
|
|
50
50
|
| `maxLength` | `number` | No | — | Maximum character length for an input. This also changes the width to roughly the same size as the max length. This i... |
|
|
@@ -58,9 +58,9 @@ For more details about `validation` using `Input` components, see the
|
|
|
58
58
|
| `placeholder` | `string` | No | — | Text that appears inside the input when empty and floats above the value as a mini label once the user enters a value... |
|
|
59
59
|
| `prefix` | `Affix` | No | — | Adds a prefix label and icon to the field |
|
|
60
60
|
| `readonly` | `boolean` | No | — | Prevents users from editing the value. |
|
|
61
|
-
| `ref` | `Ref<
|
|
61
|
+
| `ref` | `Ref<InputNumberRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
62
62
|
| `showMiniLabel` | `boolean` | No | `true` | Controls the visibility of the mini label that appears inside the input when a value is entered. By default, the plac... |
|
|
63
|
-
| `size` | `"
|
|
63
|
+
| `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
|
|
64
64
|
| `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 |
|
|
65
65
|
| `validations` | `RegisterOptions` | No | — | Show an error message above the field. This also highlights the the field red if an error message shows up. |
|
|
66
66
|
| `value` | `number` | No | — | Set the component to the given value. |
|
|
@@ -27,9 +27,9 @@ refer to [InputText](../InputText/InputText.md).
|
|
|
27
27
|
| Prop | Type | Required | Default | Description |
|
|
28
28
|
|------|------|----------|---------|-------------|
|
|
29
29
|
| `align` | `"center" | "right"` | No | — | Determines the alignment of the text inside the input. |
|
|
30
|
-
| `autocomplete` | `
|
|
30
|
+
| `autocomplete` | `AutocompleteTypes | boolean` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
|
|
31
31
|
| `clearable` | `Clearable` | No | — | Add a clear action on the input that clears the value. You should always use `while-editing` if you want the input t... |
|
|
32
|
-
| `defaultValue` | `
|
|
32
|
+
| `defaultValue` | `Date | string` | No | — | Initial value of the input. Only use this when you need to pre-populate the field with a data that is not controlled ... |
|
|
33
33
|
| `description` | `ReactNode` | No | — | Further description of the input, can be used for a hint. |
|
|
34
34
|
| `disabled` | `boolean` | No | — | Disable the input |
|
|
35
35
|
| `hasVisibility` | `boolean` | No | `false` | Display toggle to change the visibility of the password input |
|
|
@@ -46,7 +46,7 @@ refer to [InputText](../InputText/InputText.md).
|
|
|
46
46
|
| `onValidation` | `(message: string) => void` | No | — | Callback to get the the status and message when validating a field @param message |
|
|
47
47
|
| `placeholder` | `string` | No | — | Text that appears inside the input when empty and floats above the value as a mini label once the user enters a value... |
|
|
48
48
|
| `showMiniLabel` | `boolean` | No | `true` | Controls the visibility of the mini label that appears inside the input when a value is entered. By default, the plac... |
|
|
49
|
-
| `size` | `"
|
|
49
|
+
| `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
|
|
50
50
|
| `validations` | `RegisterOptions` | No | — | Show an error message above the field. This also highlights the the field red if an error message shows up. |
|
|
51
51
|
| `value` | `string` | No | — | Set the component to the given value. |
|
|
52
52
|
| `version` | `1` | No | — | Experimental: Determine which version of the FormField to use. Right now this isn't used but it will be used in the f... |
|
|
@@ -46,7 +46,7 @@ edits the input.
|
|
|
46
46
|
|------|------|----------|---------|-------------|
|
|
47
47
|
| `onChange` | `(value: string) => void` | Yes | — | onChange handler that provides the new value (or event) |
|
|
48
48
|
| `value` | `string` | Yes | — | Set the component to the given value. |
|
|
49
|
-
| `autocomplete` | `
|
|
49
|
+
| `autocomplete` | `AutocompleteTypes | boolean` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
|
|
50
50
|
| `clearable` | `Clearable` | No | — | Add a clear action on the input that clears the value. You should always use `while-editing` if you want the input t... |
|
|
51
51
|
| `description` | `ReactNode` | No | — | Further description of the input, can be used for a hint. |
|
|
52
52
|
| `disabled` | `boolean` | No | — | Disable the input |
|
|
@@ -65,7 +65,7 @@ edits the input.
|
|
|
65
65
|
| `readonly` | `boolean` | No | — | Prevents users from editing the value. |
|
|
66
66
|
| `required` | `boolean` | No | — | Shows a "required" validation message when the component is left empty. |
|
|
67
67
|
| `showMiniLabel` | `boolean` | No | `true` | Controls the visibility of the mini label that appears inside the input when a value is entered. By default, the plac... |
|
|
68
|
-
| `size` | `"
|
|
68
|
+
| `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
|
|
69
69
|
| `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 |
|
|
70
70
|
| `validations` | `RegisterOptions` | No | — | Show an error message above the field. This also highlights the the field red if an error message shows up. |
|
|
71
71
|
| `version` | `1` | No | — | Experimental: Determine which version of the FormField to use. Right now this isn't used but it will be used in the f... |
|
|
@@ -287,17 +287,17 @@ they will not do anything.
|
|
|
287
287
|
| Prop | Type | Required | Default | Description |
|
|
288
288
|
|------|------|----------|---------|-------------|
|
|
289
289
|
| `align` | `"center" | "right"` | No | — | Determines the alignment of the text inside the input. |
|
|
290
|
-
| `autocomplete` | `
|
|
290
|
+
| `autocomplete` | `AutocompleteTypes | boolean` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
|
|
291
291
|
| `autofocus` | `boolean` | No | — | Determines if the input should be auto-focused, using the HTML attribute |
|
|
292
292
|
| `clearable` | `Clearable` | No | — | Add a clear action on the input that clears the value. You should always use `while-editing` if you want the input t... |
|
|
293
|
-
| `defaultValue` | `
|
|
293
|
+
| `defaultValue` | `Date | string` | No | — | Initial value of the input. Only use this when you need to pre-populate the field with a data that is not controlled ... |
|
|
294
294
|
| `description` | `ReactNode` | No | — | Further description of the input, can be used for a hint. |
|
|
295
295
|
| `disabled` | `boolean` | No | — | Disable the input |
|
|
296
296
|
| `id` | `string` | No | — | A unique identifier for the input. |
|
|
297
297
|
| `inline` | `boolean` | No | — | Adjusts the form field to go inline with a content. This also silences the given `validations` prop. You'd have to us... |
|
|
298
298
|
| `inputRef` | `RefObject<HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement>` | No | — | |
|
|
299
299
|
| `invalid` | `boolean` | No | — | Highlights the field red to indicate an error. |
|
|
300
|
-
| `keyboard` | `"
|
|
300
|
+
| `keyboard` | `"decimal" | "numeric"` | No | — | Determines what kind of keyboard appears on mobile web. |
|
|
301
301
|
| `loading` | `boolean` | No | — | Show a spinner to indicate loading |
|
|
302
302
|
| `maxLength` | `number` | No | — | Maximum character length for an input. This also changes the width to roughly the same size as the max length. This i... |
|
|
303
303
|
| `multiline` | `boolean` | No | — | Use this when you're expecting a long answer. |
|
|
@@ -311,12 +311,12 @@ they will not do anything.
|
|
|
311
311
|
| `prefix` | `Affix` | No | — | Adds a prefix label and icon to the field |
|
|
312
312
|
| `readonly` | `boolean` | No | — | Prevents users from editing the value. |
|
|
313
313
|
| `ref` | `Ref<InputTextRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
314
|
-
| `rows` | `
|
|
314
|
+
| `rows` | `RowRange | number` | No | — | Specifies the visible height of a long answer form field. Can be in the form of a single number to set a static heigh... |
|
|
315
315
|
| `showMiniLabel` | `boolean` | No | `true` | Controls the visibility of the mini label that appears inside the input when a value is entered. By default, the plac... |
|
|
316
|
-
| `size` | `"
|
|
316
|
+
| `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
|
|
317
317
|
| `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 |
|
|
318
318
|
| `toolbar` | `ReactNode` | No | — | Toolbar to render content below the input. |
|
|
319
|
-
| `toolbarVisibility` | `"
|
|
319
|
+
| `toolbarVisibility` | `"always" | "while-editing"` | No | — | Determines the visibility of the toolbar. |
|
|
320
320
|
| `validations` | `RegisterOptions` | No | — | Show an error message above the field. This also highlights the the field red if an error message shows up. |
|
|
321
|
-
| `value` | `
|
|
321
|
+
| `value` | `Date | number | string` | No | — | Set the component to the given value. |
|
|
322
322
|
| `version` | `1` | No | — | Experimental: Determine which version of the FormField to use. Right now this isn't used but it will be used in the f... |
|
|
@@ -41,7 +41,7 @@ to type `10`, `11`, or `12`.
|
|
|
41
41
|
| Prop | Type | Required | Default | Description |
|
|
42
42
|
|------|------|----------|---------|-------------|
|
|
43
43
|
| `align` | `"center" | "right"` | No | — | Determines the alignment of the text inside the input. |
|
|
44
|
-
| `autocomplete` | `
|
|
44
|
+
| `autocomplete` | `AutocompleteTypes | boolean` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
|
|
45
45
|
| `clearable` | `Clearable` | No | — | Add a clear action on the input that clears the value. You should always use `while-editing` if you want the input t... |
|
|
46
46
|
| `defaultValue` | `Date` | No | — | Intial value of the input. Only use this when you need to prepopulate the field with a data that is not controlled by... |
|
|
47
47
|
| `description` | `ReactNode` | No | — | Further description of the input, can be used for a hint. |
|
|
@@ -62,6 +62,6 @@ to type `10`, `11`, or `12`.
|
|
|
62
62
|
| `onValidation` | `(message: string) => void` | No | — | Callback to get the the status and message when validating a field @param message |
|
|
63
63
|
| `placeholder` | `string` | No | — | Text that appears inside the input when empty and floats above the value as a mini label once the user enters a value... |
|
|
64
64
|
| `readonly` | `boolean` | No | — | Prevents users from editing the value. |
|
|
65
|
-
| `size` | `"
|
|
65
|
+
| `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
|
|
66
66
|
| `validations` | `RegisterOptions` | No | — | Show an error message above the field. This also highlights the the field red if an error message shows up. |
|
|
67
67
|
| `value` | `Date` | No | — | Set the component to the given value. |
|
|
@@ -182,28 +182,18 @@ window.HTMLElement.prototype.scrollIntoView = scrollIntoViewMock;
|
|
|
182
182
|
| `boxSizing` | `BoxSizing` | No | `"content-box"` | Sets the box-sizing for the thumbnails in the lightbox. This is a solution for a problem where tailwind was setting t... |
|
|
183
183
|
| `imageIndex` | `number` | No | — | Use this to specify which image in `images` to initialize the lightbox with. This is useful when you have a collectio... |
|
|
184
184
|
|
|
185
|
-
#### LightBox.Provider
|
|
186
|
-
|
|
187
|
-
| Prop | Type | Required | Default | Description |
|
|
188
|
-
|------|------|----------|---------|-------------|
|
|
189
|
-
| `images` | `PresentedImage[]` | Yes | — | Images is an array of objects defining a LightBox image. This object consists of `title`, `caption`, `alt` and `url`.... |
|
|
190
|
-
| `boxSizing` | `BoxSizing` | No | `content-box` | Sets the box-sizing for the thumbnails in the lightbox. This is a solution for a problem where tailwind was setting t... |
|
|
191
|
-
| `imageIndex` | `number` | No | `0` | Use this to specify which image in `images` to initialize the lightbox with. This is useful when you have a collectio... |
|
|
192
|
-
| `onImageChange` | `(index: number) => void` | No | — | Callback function that is invoked whenever the current image index changes. This includes when the user navigates to ... |
|
|
193
|
-
| `onRequestClose` | `(options: RequestCloseOptions) => void` | No | — | This function must set open to false in order to close the lightbox. Note there is a 300ms easing animation on lightb... |
|
|
194
|
-
| `open` | `boolean` | No | `true` | Specify if the Lightbox is open or closed. |
|
|
195
|
-
|
|
196
185
|
#### LightBox.Background
|
|
197
186
|
|
|
198
187
|
| Prop | Type | Required | Default | Description |
|
|
199
188
|
|------|------|----------|---------|-------------|
|
|
200
189
|
| `className` | `string` | No | — | |
|
|
201
190
|
|
|
202
|
-
#### LightBox.
|
|
191
|
+
#### LightBox.Navigation
|
|
203
192
|
|
|
204
193
|
| Prop | Type | Required | Default | Description |
|
|
205
194
|
|------|------|----------|---------|-------------|
|
|
206
|
-
| `
|
|
195
|
+
| `nextButtonClassName` | `string` | No | — | The class name to apply to the next button wrapper. |
|
|
196
|
+
| `prevButtonClassName` | `string` | No | — | The class name to apply to the previous button wrapper. |
|
|
207
197
|
|
|
208
198
|
#### LightBox.OpenInNewTabAction
|
|
209
199
|
|
|
@@ -211,15 +201,25 @@ window.HTMLElement.prototype.scrollIntoView = scrollIntoViewMock;
|
|
|
211
201
|
|------|------|----------|---------|-------------|
|
|
212
202
|
| `ariaLabel` | `string` | No | `Open image in new tab` | Accessible label for the action, also used as the tooltip message. |
|
|
213
203
|
|
|
214
|
-
#### LightBox.
|
|
204
|
+
#### LightBox.Overlay
|
|
215
205
|
|
|
216
206
|
| Prop | Type | Required | Default | Description |
|
|
217
207
|
|------|------|----------|---------|-------------|
|
|
218
208
|
| `className` | `string` | No | — | |
|
|
219
209
|
|
|
220
|
-
#### LightBox.
|
|
210
|
+
#### LightBox.Provider
|
|
221
211
|
|
|
222
212
|
| Prop | Type | Required | Default | Description |
|
|
223
213
|
|------|------|----------|---------|-------------|
|
|
224
|
-
| `
|
|
225
|
-
| `
|
|
214
|
+
| `images` | `PresentedImage[]` | Yes | — | Images is an array of objects defining a LightBox image. This object consists of `title`, `caption`, `alt` and `url`.... |
|
|
215
|
+
| `boxSizing` | `BoxSizing` | No | `content-box` | Sets the box-sizing for the thumbnails in the lightbox. This is a solution for a problem where tailwind was setting t... |
|
|
216
|
+
| `imageIndex` | `number` | No | `0` | Use this to specify which image in `images` to initialize the lightbox with. This is useful when you have a collectio... |
|
|
217
|
+
| `onImageChange` | `(index: number) => void` | No | — | Callback function that is invoked whenever the current image index changes. This includes when the user navigates to ... |
|
|
218
|
+
| `onRequestClose` | `(options: RequestCloseOptions) => void` | No | — | This function must set open to false in order to close the lightbox. Note there is a 300ms easing animation on lightb... |
|
|
219
|
+
| `open` | `boolean` | No | `true` | Specify if the Lightbox is open or closed. |
|
|
220
|
+
|
|
221
|
+
#### LightBox.Slides
|
|
222
|
+
|
|
223
|
+
| Prop | Type | Required | Default | Description |
|
|
224
|
+
|------|------|----------|---------|-------------|
|
|
225
|
+
| `className` | `string` | No | — | |
|
package/dist/docs/Menu/Menu.md
CHANGED
|
@@ -458,6 +458,8 @@ through inline styles.
|
|
|
458
458
|
|
|
459
459
|
### Web
|
|
460
460
|
|
|
461
|
+
#### Menu
|
|
462
|
+
|
|
461
463
|
| Prop | Type | Required | Default | Description |
|
|
462
464
|
|------|------|----------|---------|-------------|
|
|
463
465
|
| `items` | `SectionProps[]` | Yes | — | Collection of action items. |
|
|
@@ -469,3 +471,123 @@ through inline styles.
|
|
|
469
471
|
| `style` | `CSSProperties` | No | — | |
|
|
470
472
|
| `UNSAFE_className` | `string | { menu?: string; header?: string; action?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
471
473
|
| `UNSAFE_style` | `CSSProperties | { menu?: CSSProperties; header?: CSSProperties; action?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
474
|
+
|
|
475
|
+
#### Menu.Content
|
|
476
|
+
|
|
477
|
+
| Prop | Type | Required | Default | Description |
|
|
478
|
+
|------|------|----------|---------|-------------|
|
|
479
|
+
| `className` | `string` | No | — | |
|
|
480
|
+
| `preferredPlacement` | `Placement` | No | — | |
|
|
481
|
+
| `style` | `CSSProperties` | No | — | |
|
|
482
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
483
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
484
|
+
|
|
485
|
+
#### Menu.Group
|
|
486
|
+
|
|
487
|
+
| Prop | Type | Required | Default | Description |
|
|
488
|
+
|------|------|----------|---------|-------------|
|
|
489
|
+
| `ariaLabel` | `string` | No | — | |
|
|
490
|
+
| `className` | `string` | No | — | |
|
|
491
|
+
| `style` | `CSSProperties` | No | — | |
|
|
492
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
493
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
494
|
+
|
|
495
|
+
#### Menu.GroupLabel
|
|
496
|
+
|
|
497
|
+
| Prop | Type | Required | Default | Description |
|
|
498
|
+
|------|------|----------|---------|-------------|
|
|
499
|
+
| `className` | `string` | No | — | |
|
|
500
|
+
| `style` | `CSSProperties` | No | — | |
|
|
501
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
502
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
503
|
+
|
|
504
|
+
#### Menu.Header
|
|
505
|
+
|
|
506
|
+
| Prop | Type | Required | Default | Description |
|
|
507
|
+
|------|------|----------|---------|-------------|
|
|
508
|
+
| `className` | `string` | No | — | |
|
|
509
|
+
| `style` | `CSSProperties` | No | — | |
|
|
510
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
511
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
512
|
+
|
|
513
|
+
#### Menu.ItemIcon
|
|
514
|
+
|
|
515
|
+
| Prop | Type | Required | Default | Description |
|
|
516
|
+
|------|------|----------|---------|-------------|
|
|
517
|
+
| `name` | `IconNames` | Yes | — | The icon to show. |
|
|
518
|
+
| `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... |
|
|
519
|
+
| `customColor` | `string` | No | — | Sets a custom color for the icon. Can be a rgb() or hex value. |
|
|
520
|
+
| `size` | `"base" | "large" | "small"` | No | `base` | Changes the size to small or large. |
|
|
521
|
+
| `testID` | `string` | No | — | Used to locate this view in end-to-end tests |
|
|
522
|
+
| `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... |
|
|
523
|
+
| `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... |
|
|
524
|
+
|
|
525
|
+
#### Menu.ItemPrefix
|
|
526
|
+
|
|
527
|
+
| Prop | Type | Required | Default | Description |
|
|
528
|
+
|------|------|----------|---------|-------------|
|
|
529
|
+
| `className` | `string` | No | — | |
|
|
530
|
+
| `style` | `CSSProperties` | No | — | |
|
|
531
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
532
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
533
|
+
|
|
534
|
+
#### Menu.ItemSuffix
|
|
535
|
+
|
|
536
|
+
| Prop | Type | Required | Default | Description |
|
|
537
|
+
|------|------|----------|---------|-------------|
|
|
538
|
+
| `className` | `string` | No | — | |
|
|
539
|
+
| `style` | `CSSProperties` | No | — | |
|
|
540
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
541
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
542
|
+
|
|
543
|
+
#### Menu.RadioGroup
|
|
544
|
+
|
|
545
|
+
| Prop | Type | Required | Default | Description |
|
|
546
|
+
|------|------|----------|---------|-------------|
|
|
547
|
+
| `className` | `string` | No | — | |
|
|
548
|
+
| `defaultValue` | `string` | No | — | |
|
|
549
|
+
| `onValueChange` | `(value: string) => void` | No | — | |
|
|
550
|
+
| `style` | `CSSProperties` | No | — | |
|
|
551
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
552
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
553
|
+
| `value` | `string` | No | — | |
|
|
554
|
+
|
|
555
|
+
#### Menu.Section
|
|
556
|
+
|
|
557
|
+
| Prop | Type | Required | Default | Description |
|
|
558
|
+
|------|------|----------|---------|-------------|
|
|
559
|
+
| `ariaLabel` | `string` | No | — | |
|
|
560
|
+
| `className` | `string` | No | — | |
|
|
561
|
+
| `style` | `CSSProperties` | No | — | |
|
|
562
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
563
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
564
|
+
|
|
565
|
+
#### Menu.Separator
|
|
566
|
+
|
|
567
|
+
| Prop | Type | Required | Default | Description |
|
|
568
|
+
|------|------|----------|---------|-------------|
|
|
569
|
+
| `className` | `string` | No | — | |
|
|
570
|
+
| `style` | `CSSProperties` | No | — | |
|
|
571
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
572
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
573
|
+
|
|
574
|
+
#### Menu.Submenu
|
|
575
|
+
|
|
576
|
+
| Prop | Type | Required | Default | Description |
|
|
577
|
+
|------|------|----------|---------|-------------|
|
|
578
|
+
| `className` | `string` | No | — | |
|
|
579
|
+
| `defaultOpen` | `boolean` | No | — | |
|
|
580
|
+
| `onOpenChange` | `(isOpen: boolean) => void` | No | — | |
|
|
581
|
+
| `open` | `boolean` | No | — | |
|
|
582
|
+
| `style` | `CSSProperties` | No | — | |
|
|
583
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
584
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
585
|
+
|
|
586
|
+
#### Menu.SubmenuContent
|
|
587
|
+
|
|
588
|
+
| Prop | Type | Required | Default | Description |
|
|
589
|
+
|------|------|----------|---------|-------------|
|
|
590
|
+
| `className` | `string` | No | — | |
|
|
591
|
+
| `style` | `CSSProperties` | No | — | |
|
|
592
|
+
| `UNSAFE_className` | `string` | No | — | @deprecated Use `className` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
|
593
|
+
| `UNSAFE_style` | `CSSProperties` | No | — | @deprecated Use `style` instead. This is kept for backward compatibility on the composable Menu pieces. |
|
package/dist/docs/Modal/Modal.md
CHANGED
|
@@ -292,7 +292,7 @@ screen.getByRole("dialog", { name: /Billing Settings/i });
|
|
|
292
292
|
| `open` | `boolean` | No | `false` | |
|
|
293
293
|
| `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 | — | |
|
|
294
294
|
| `secondaryAction` | `{ 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 | — | |
|
|
295
|
-
| `size` | `"
|
|
295
|
+
| `size` | `"fullScreen" | "large" | "small"` | No | — | |
|
|
296
296
|
| `tertiaryAction` | `{ 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 | — | |
|
|
297
297
|
| `title` | `string` | No | `false` | |
|
|
298
298
|
| `version` | `1` | No | — | |
|
|
@@ -50,4 +50,4 @@ Features and behavior are announced to the user when using a screen reader.
|
|
|
50
50
|
| `defaultLabel` | `string` | Yes | — | The label to be displayed by default when no options are selected |
|
|
51
51
|
| `onOptionsChange` | `Dispatch<SetStateAction<Options>>` | Yes | — | Change handler |
|
|
52
52
|
| `options` | `Options` | Yes | — | List of options to be checked |
|
|
53
|
-
| `size` | `"
|
|
53
|
+
| `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
|
package/dist/docs/Page/Page.md
CHANGED
|
@@ -313,7 +313,13 @@ composable actions, this is the simplest way to use Page:
|
|
|
313
313
|
| `secondaryAction` | `ButtonActionProps` | No | — | Page title secondary action button settings. |
|
|
314
314
|
| `subtitle` | `string` | No | — | Subtitle of the page. |
|
|
315
315
|
| `titleMetaData` | `ReactNode` | No | — | TitleMetaData component to be displayed next to the title. Only compatible with string titles. |
|
|
316
|
-
| `width` | `"fill" | "
|
|
316
|
+
| `width` | `"fill" | "narrow" | "standard"` | No | `standard` | Determines the width of the page. Fill makes the width grow to 100%. Standard caps out at 1280px. Narrow caps out ... |
|
|
317
|
+
|
|
318
|
+
#### Page.ActionMenu
|
|
319
|
+
|
|
320
|
+
| Prop | Type | Required | Default | Description |
|
|
321
|
+
|------|------|----------|---------|-------------|
|
|
322
|
+
| `ref` | `RefObject<HTMLDivElement>` | No | — | |
|
|
317
323
|
|
|
318
324
|
#### Page.ActionPrimary
|
|
319
325
|
|
|
@@ -327,11 +333,11 @@ composable actions, this is the simplest way to use Page:
|
|
|
327
333
|
|------|------|----------|---------|-------------|
|
|
328
334
|
| `ref` | `RefObject<HTMLDivElement>` | No | — | |
|
|
329
335
|
|
|
330
|
-
#### Page.
|
|
336
|
+
#### Page.Menu
|
|
331
337
|
|
|
332
338
|
| Prop | Type | Required | Default | Description |
|
|
333
339
|
|------|------|----------|---------|-------------|
|
|
334
|
-
| `
|
|
340
|
+
| `triggerLabel` | `string` | No | `More Actions` | |
|
|
335
341
|
|
|
336
342
|
#### Page.PrimaryButton
|
|
337
343
|
|
|
@@ -356,9 +362,3 @@ composable actions, this is the simplest way to use Page:
|
|
|
356
362
|
| `loading` | `boolean` | No | — | |
|
|
357
363
|
| `onClick` | `() => void` | No | — | |
|
|
358
364
|
| `ref` | `RefObject<HTMLDivElement>` | No | — | |
|
|
359
|
-
|
|
360
|
-
#### Page.Menu
|
|
361
|
-
|
|
362
|
-
| Prop | Type | Required | Default | Description |
|
|
363
|
-
|------|------|----------|---------|-------------|
|
|
364
|
-
| `triggerLabel` | `string` | No | `More Actions` | |
|