@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.
Files changed (55) hide show
  1. package/dist/Menu/Menu.d.ts +21 -1
  2. package/dist/Menu-cjs.js +19 -21
  3. package/dist/Menu-es.js +21 -23
  4. package/dist/docs/AnimatedPresence/AnimatedPresence.md +1 -1
  5. package/dist/docs/Autocomplete/AutocompleteV1.md +1 -1
  6. package/dist/docs/Autocomplete/AutocompleteV2.md +1 -1
  7. package/dist/docs/Banner/Banner.md +41 -41
  8. package/dist/docs/Box/Box.md +5 -5
  9. package/dist/docs/Button/Button.md +13 -13
  10. package/dist/docs/Checkbox/Checkbox.md +2 -2
  11. package/dist/docs/Chip/Chip.md +2 -2
  12. package/dist/docs/Cluster/Cluster.md +3 -3
  13. package/dist/docs/Combobox/Combobox.md +1 -1
  14. package/dist/docs/ConfirmationModal/ConfirmationModal.md +3 -3
  15. package/dist/docs/Content/Content.md +2 -2
  16. package/dist/docs/Countdown/Countdown.md +1 -1
  17. package/dist/docs/DataList/DataList.md +24 -24
  18. package/dist/docs/DataTable/DataTable.md +7 -7
  19. package/dist/docs/Divider/Divider.md +1 -1
  20. package/dist/docs/Flex/Flex.md +1 -1
  21. package/dist/docs/Form/Form.md +1 -1
  22. package/dist/docs/FormField/FormField.md +6 -6
  23. package/dist/docs/FormatDate/FormatDate.md +1 -1
  24. package/dist/docs/FormatFile/FormatFile.md +22 -22
  25. package/dist/docs/FormatRelativeDateTime/FormatRelativeDateTime.md +1 -1
  26. package/dist/docs/FormatTime/FormatTime.md +1 -1
  27. package/dist/docs/Gallery/Gallery.md +1 -1
  28. package/dist/docs/Glimmer/Glimmer.md +7 -7
  29. package/dist/docs/Grid/Grid.md +2 -2
  30. package/dist/docs/Heading/Heading.md +2 -2
  31. package/dist/docs/Icon/Icon.md +1 -1
  32. package/dist/docs/InlineLabel/InlineLabel.md +1 -1
  33. package/dist/docs/InputDate/InputDate.md +4 -4
  34. package/dist/docs/InputEmail/InputEmail.md +3 -3
  35. package/dist/docs/InputFile/InputFile.md +7 -7
  36. package/dist/docs/InputNumber/InputNumber.md +5 -5
  37. package/dist/docs/InputPassword/InputPassword.md +3 -3
  38. package/dist/docs/InputPhoneNumber/InputPhoneNumber.md +2 -2
  39. package/dist/docs/InputText/InputText.md +7 -7
  40. package/dist/docs/InputTime/InputTime.md +2 -2
  41. package/dist/docs/LightBox/LightBox.md +17 -17
  42. package/dist/docs/Menu/Menu.md +122 -0
  43. package/dist/docs/Modal/Modal.md +1 -1
  44. package/dist/docs/MultiSelect/MultiSelect.md +1 -1
  45. package/dist/docs/Page/Page.md +9 -9
  46. package/dist/docs/Popover/Popover.md +11 -11
  47. package/dist/docs/ProgressBar/ProgressBar.md +1 -1
  48. package/dist/docs/RadioGroup/RadioGroup.md +1 -1
  49. package/dist/docs/SegmentedControl/SegmentedControl.md +2 -2
  50. package/dist/docs/Select/Select.md +4 -4
  51. package/dist/docs/SideKick/SideKick.md +1 -1
  52. package/dist/docs/Spinner/Spinner.md +1 -1
  53. package/dist/docs/Text/Text.md +3 -3
  54. package/dist/docs/Toast/Toast.md +1 -1
  55. package/package.json +2 -2
@@ -103,4 +103,4 @@ message to screen-readers and set focus to the impacted portion of the Form.
103
103
  |------|------|----------|---------|-------------|
104
104
  | `onStateChange` | `(formState: { isDirty: boolean; isValid: boolean; }) => void` | No | — | |
105
105
  | `onSubmit` | `() => void` | No | — | Callback for when the form has been sucessfully submitted. |
106
- | `ref` | `Ref<InputTextRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
106
+ | `ref` | `Ref<FormRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
@@ -53,18 +53,18 @@ export function SpecialInput(props) {
53
53
  |------|------|----------|---------|-------------|
54
54
  | `actionsRef` | `RefObject<FieldActionsRef>` | No | — | |
55
55
  | `align` | `"center" | "right"` | No | — | Determines the alignment of the text inside the input. |
56
- | `autocomplete` | `boolean | AutocompleteTypes` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
56
+ | `autocomplete` | `AutocompleteTypes | boolean` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
57
57
  | `autofocus` | `boolean` | No | — | Determines if the input should be auto-focused, using the HTML attribute |
58
58
  | `children` | `ReactNode` | No | — | If you need to pass in a children. For example, `<options>` inside `<select>`. |
59
59
  | `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... |
60
- | `defaultValue` | `string | Date` | No | — | Initial value of the input. Only use this when you need to pre-populate the field with a data that is not controlled ... |
60
+ | `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 ... |
61
61
  | `description` | `ReactNode` | No | — | Further description of the input, can be used for a hint. |
62
62
  | `disabled` | `boolean` | No | — | Disable the input |
63
63
  | `id` | `string` | No | — | A unique identifier for the input. |
64
64
  | `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... |
65
65
  | `inputRef` | `RefObject<HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement>` | No | — | |
66
66
  | `invalid` | `boolean` | No | — | Highlights the field red to indicate an error. |
67
- | `keyboard` | `"numeric" | "decimal"` | No | — | Determines what kind of keyboard appears on mobile web. |
67
+ | `keyboard` | `"decimal" | "numeric"` | No | — | Determines what kind of keyboard appears on mobile web. |
68
68
  | `loading` | `boolean` | No | — | Show a spinner to indicate loading |
69
69
  | `max` | `number` | No | — | Specifies the maximum numerical or date value that a user can type |
70
70
  | `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... |
@@ -82,12 +82,12 @@ export function SpecialInput(props) {
82
82
  | `readonly` | `boolean` | No | — | Prevents users from editing the value. |
83
83
  | `rows` | `number` | No | — | Exclusively for textareas. Specifies the visible height of a textarea. |
84
84
  | `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... |
85
- | `size` | `"small" | "large"` | No | — | Adjusts the interface to either have small or large spacing. |
85
+ | `size` | `"large" | "small"` | No | — | Adjusts the interface to either have small or large spacing. |
86
86
  | `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 |
87
87
  | `toolbar` | `ReactNode` | No | — | Toolbar to render content below the input. |
88
- | `toolbarVisibility` | `"while-editing" | "always"` | No | — | Determines the visibility of the toolbar. |
88
+ | `toolbarVisibility` | `"always" | "while-editing"` | No | — | Determines the visibility of the toolbar. |
89
89
  | `type` | `FormFieldTypes` | No | — | Determines what kind of form field should the component give you. |
90
90
  | `validations` | `RegisterOptions` | No | — | Show an error message above the field. This also highlights the the field red if an error message shows up. |
91
- | `value` | `string | number | Date` | No | — | Set the component to the given value. |
91
+ | `value` | `Date | number | string` | No | — | Set the component to the given value. |
92
92
  | `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... |
93
93
  | `wrapperRef` | `RefObject<HTMLDivElement>` | No | — | |
@@ -43,5 +43,5 @@ If you require a string instead of a component use strFormatDate.
43
43
 
44
44
  | Prop | Type | Required | Default | Description |
45
45
  |------|------|----------|---------|-------------|
46
- | `date` | `string | Date` | Yes | — | Date to be formatted. A `string` should be an ISO 8601 format date string. |
46
+ | `date` | `Date | string` | Yes | — | Date to be formatted. A `string` should be an ISO 8601 format date string. |
47
47
  | `showYear` | `boolean` | No | `true` | Boolean to show year or not. |
@@ -31,41 +31,34 @@ image, while expanded is used to display a file alongside its metadata.
31
31
  | Prop | Type | Required | Default | Description |
32
32
  |------|------|----------|---------|-------------|
33
33
  | `file` | `FileUpload` | Yes | — | File upload details object. (See FileUpload type.) |
34
- | `display` | `"expanded" | "compact"` | No | `expanded` | To display as either a file row or thumbnail |
35
- | `displaySize` | `"large" | "base"` | No | `base` | The base dimensions of the thumbnail |
34
+ | `display` | `"compact" | "expanded"` | No | `expanded` | To display as either a file row or thumbnail |
35
+ | `displaySize` | `"base" | "large"` | No | `base` | The base dimensions of the thumbnail |
36
36
  | `onClick` | `(event: MouseEvent<HTMLButtonElement | HTMLDivElement, MouseEvent>) => void` | No | — | Function to execute when format file is clicked |
37
37
  | `onDelete` | `() => void` | No | — | onDelete callback - this function will be called when the delete action is triggered |
38
38
 
39
- #### FormatFile.DeleteButtonContainer
40
-
41
- | Prop | Type | Required | Default | Description |
42
- |------|------|----------|---------|-------------|
43
- | `className` | `string` | No | — | |
44
- | `isHidden` | `boolean` | No | — | |
45
-
46
- #### FormatFile.ProgressContainer
39
+ #### FormatFile.Body
47
40
 
48
41
  | Prop | Type | Required | Default | Description |
49
42
  |------|------|----------|---------|-------------|
43
+ | `isComplete` | `boolean` | Yes | — | |
44
+ | `ariaBusy` | `boolean` | No | — | |
50
45
  | `className` | `string` | No | — | |
51
- | `isHidden` | `boolean` | No | — | |
46
+ | `onClick` | `MouseEventHandler<HTMLButtonElement | HTMLDivElement>` | No | — | |
47
+ | `tabIndex` | `number` | No | — | |
48
+ | `type` | `"button" | "reset" | "submit"` | No | — | |
52
49
 
53
- #### FormatFile.ThumbnailContainer
50
+ #### FormatFile.DeleteButton
54
51
 
55
52
  | Prop | Type | Required | Default | Description |
56
53
  |------|------|----------|---------|-------------|
57
- | `className` | `string` | No | — | |
54
+ | `onDelete` | `(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void` | No | — | |
58
55
 
59
- #### FormatFile.Body
56
+ #### FormatFile.DeleteButtonContainer
60
57
 
61
58
  | Prop | Type | Required | Default | Description |
62
59
  |------|------|----------|---------|-------------|
63
- | `isComplete` | `boolean` | Yes | — | |
64
- | `ariaBusy` | `boolean` | No | — | |
65
60
  | `className` | `string` | No | — | |
66
- | `onClick` | `MouseEventHandler<HTMLButtonElement | HTMLDivElement>` | No | — | |
67
- | `tabIndex` | `number` | No | — | |
68
- | `type` | `"submit" | "button" | "reset"` | No | — | |
61
+ | `isHidden` | `boolean` | No | — | |
69
62
 
70
63
  #### FormatFile.Expanded
71
64
 
@@ -75,14 +68,21 @@ image, while expanded is used to display a file alongside its metadata.
75
68
  | `fileSize` | `string` | Yes | — | |
76
69
  | `isVisible` | `boolean` | Yes | — | |
77
70
 
78
- #### FormatFile.Wrapper
71
+ #### FormatFile.ProgressContainer
79
72
 
80
73
  | Prop | Type | Required | Default | Description |
81
74
  |------|------|----------|---------|-------------|
82
75
  | `className` | `string` | No | — | |
76
+ | `isHidden` | `boolean` | No | — | |
83
77
 
84
- #### FormatFile.DeleteButton
78
+ #### FormatFile.ThumbnailContainer
85
79
 
86
80
  | Prop | Type | Required | Default | Description |
87
81
  |------|------|----------|---------|-------------|
88
- | `onDelete` | `(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void` | No | — | |
82
+ | `className` | `string` | No | — | |
83
+
84
+ #### FormatFile.Wrapper
85
+
86
+ | Prop | Type | Required | Default | Description |
87
+ |------|------|----------|---------|-------------|
88
+ | `className` | `string` | No | — | |
@@ -27,4 +27,4 @@ format is Month Day, Year.
27
27
 
28
28
  | Prop | Type | Required | Default | Description |
29
29
  |------|------|----------|---------|-------------|
30
- | `date` | `string | Date` | Yes | — | Date to be displayed. A `string` should be an ISO 8601 format date string. |
30
+ | `date` | `Date | string` | Yes | — | Date to be displayed. A `string` should be an ISO 8601 format date string. |
@@ -28,5 +28,5 @@ newDate.setHours(22, 35, 0, 0);
28
28
 
29
29
  | Prop | Type | Required | Default | Description |
30
30
  |------|------|----------|---------|-------------|
31
- | `time` | `string | Date` | Yes | — | Time (as JS Date) to be displayed. A `string` should be an ISO 8601 format date string. |
31
+ | `time` | `Date | string` | Yes | — | Time (as JS Date) to be displayed. A `string` should be an ISO 8601 format date string. |
32
32
  | `use24HourClock` | `boolean` | No | — | Optionally specify clock format. If `undefined` system format will be respected. |
@@ -36,4 +36,4 @@ will also slightly dim a particular thumbnail when the cursor hovers over it.
36
36
  | `files` | `GalleryFile[]` | Yes | — | The files for the Gallery to display |
37
37
  | `max` | `number` | No | — | The max number of thumbnails before no more thumbnails are displayed unless the user clicks an action to display the ... |
38
38
  | `onDelete` | `(file: GalleryFile) => void` | No | — | onDelete callback - this function will be called when the delete action is triggered on a Gallery image |
39
- | `size` | `"large" | "base"` | No | `base` | The size of the files and their spacing in the gallery |
39
+ | `size` | `"base" | "large"` | No | `base` | The size of the files and their spacing in the gallery |
@@ -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` | `"small" | "large" | "base" | "larger" | "largest" | "auto"` | 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... |
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.Header
148
+ #### Glimmer.Button
149
149
 
150
150
  | Prop | Type | Required | Default | Description |
151
151
  |------|------|----------|---------|-------------|
152
- | `level` | `1 | 2 | 5 | 3 | 4` | No | `3` | Adjust the size of the `Glimmer.Header`. |
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.Text
157
+ #### Glimmer.Header
158
158
 
159
159
  | Prop | Type | Required | Default | Description |
160
160
  |------|------|----------|---------|-------------|
161
- | `lines` | `1 | 2 | 3` | No | `3` | Set how many lines shows up. |
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.Button
166
+ #### Glimmer.Text
167
167
 
168
168
  | Prop | Type | Required | Default | Description |
169
169
  |------|------|----------|---------|-------------|
170
- | `fullWidth` | `boolean` | No | `false` | Allow `Glimmer.Button` to go full width. |
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. |
@@ -67,8 +67,8 @@ instead.
67
67
  | Prop | Type | Required | Default | Description |
68
68
  |------|------|----------|---------|-------------|
69
69
  | `children` | `ReactNode` | Yes | — | `Grid.Cell` children |
70
- | `alignItems` | `"stretch" | "center" | "end" | "start"` | 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` | `boolean | GapSpacing` | No | `true` | Add spacing between elements. Can be a boolean for default spacing, or a semantic token for custom spacing. @deprecat... |
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` | `"span" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p"` | No | — | Allows overriding of the element rendered. Defaults to the heading specified with level. |
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` | `"small" | "large" | "base" | "larger" | "single" | "unlimited"` | No | `unlimited` | The maximum amount of lines the text can occupy before being truncated with "...". Uses predefined string values that... |
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... |
@@ -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` | `"small" | "large" | "base"` | No | `base` | Changes the size to small or large. |
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` | `"small" | "large" | "base" | "larger"` | No | `base` | The size of the label |
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` | `"list" | "none" | "inline" | "both"` | No | — | Indicates the type of autocomplete interaction. @see {@link https://www.w3.org/TR/wai-aria-1.2/#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` | `"email" | "search" | "text" | "url" | "none" | "tel" | "numeric" | "decimal"` | No | — | Input mode hint for virtual keyboards. |
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<InputTextRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
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` | `"small" | "large"` | No | — | Adjusts the interface to either have small or large spacing. |
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` | `string | Date` | No | — | Initial value of the input. Only use this when you need to pre-populate the field with a data that is not controlled ... |
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` | `"small" | "large"` | No | — | Adjusts the interface to either have small or large spacing. |
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` | `string | number | Date` | No | — | Set the component to the given 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` | `"small" | "base"` | No | `base` | Size of the InputFile |
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` | `"small" | "large" | "base" | "larger" | "single" | "unlimited"` | No | — | |
410
- | `size` | `"small" | "large" | "base"` | No | `small` | |
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` | `"info" | "disabled" | "success" | "error" | "default" | "subdued" | "warn"` | No | `subdued` | |
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` | `"small" | "large" | "base" | "larger" | "single" | "unlimited"` | No | — | |
422
- | `size` | `"small" | "large" | "base"` | No | `small` | |
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` | `"info" | "disabled" | "success" | "error" | "default" | "subdued" | "warn"` | No | — | |
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` | `boolean | AutocompleteTypes` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
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` | `string | Date` | No | — | Initial value of the input. Only use this when you need to pre-populate the field with a data that is not controlled ... |
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` | `"numeric" | "decimal"` | No | — | Determines what kind of keyboard appears on mobile web. |
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<InputTextRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
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` | `"small" | "large"` | No | — | Adjusts the interface to either have small or large spacing. |
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` | `boolean | AutocompleteTypes` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
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` | `string | Date` | No | — | Initial value of the input. Only use this when you need to pre-populate the field with a data that is not controlled ... |
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` | `"small" | "large"` | No | — | Adjusts the interface to either have small or large spacing. |
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` | `boolean | AutocompleteTypes` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
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` | `"small" | "large"` | No | — | Adjusts the interface to either have small or large spacing. |
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` | `boolean | AutocompleteTypes` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
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` | `string | Date` | No | — | Initial value of the input. Only use this when you need to pre-populate the field with a data that is not controlled ... |
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` | `"numeric" | "decimal"` | No | — | Determines what kind of keyboard appears on mobile web. |
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` | `number | RowRange` | 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... |
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` | `"small" | "large"` | No | — | Adjusts the interface to either have small or large spacing. |
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` | `"while-editing" | "always"` | No | — | Determines the visibility of the toolbar. |
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` | `string | number | Date` | No | — | Set the component to the given 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` | `boolean | AutocompleteTypes` | No | — | Determines if browser form autocomplete is enabled. Note that "one-time-code" is experimental and should not be used ... |
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` | `"small" | "large"` | No | — | Adjusts the interface to either have small or large spacing. |
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.Overlay
191
+ #### LightBox.Navigation
203
192
 
204
193
  | Prop | Type | Required | Default | Description |
205
194
  |------|------|----------|---------|-------------|
206
- | `className` | `string` | No | — | |
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.Slides
204
+ #### LightBox.Overlay
215
205
 
216
206
  | Prop | Type | Required | Default | Description |
217
207
  |------|------|----------|---------|-------------|
218
208
  | `className` | `string` | No | — | |
219
209
 
220
- #### LightBox.Navigation
210
+ #### LightBox.Provider
221
211
 
222
212
  | Prop | Type | Required | Default | Description |
223
213
  |------|------|----------|---------|-------------|
224
- | `nextButtonClassName` | `string` | No | — | The class name to apply to the next button wrapper. |
225
- | `prevButtonClassName` | `string` | No | | The class name to apply to the previous button wrapper. |
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 | — | |