@jobber/components 7.11.0 → 7.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Menu/Menu.d.ts +21 -1
- package/dist/Menu-cjs.js +41 -25
- package/dist/Menu-es.js +43 -27
- package/dist/docs/AnimatedPresence/AnimatedPresence.md +1 -1
- package/dist/docs/Autocomplete/AutocompleteV1.md +1 -1
- package/dist/docs/Autocomplete/AutocompleteV2.md +1 -1
- package/dist/docs/Banner/Banner.md +41 -41
- package/dist/docs/Box/Box.md +5 -5
- package/dist/docs/Button/Button.md +13 -13
- package/dist/docs/Checkbox/Checkbox.md +2 -2
- package/dist/docs/Chip/Chip.md +2 -2
- package/dist/docs/Cluster/Cluster.md +3 -3
- package/dist/docs/Combobox/Combobox.md +1 -1
- package/dist/docs/ConfirmationModal/ConfirmationModal.md +3 -3
- package/dist/docs/Content/Content.md +2 -2
- package/dist/docs/Countdown/Countdown.md +1 -1
- package/dist/docs/DataList/DataList.md +24 -24
- package/dist/docs/DataTable/DataTable.md +7 -7
- package/dist/docs/Divider/Divider.md +1 -1
- package/dist/docs/Flex/Flex.md +1 -1
- package/dist/docs/Form/Form.md +1 -1
- package/dist/docs/FormField/FormField.md +6 -6
- package/dist/docs/FormatDate/FormatDate.md +1 -1
- package/dist/docs/FormatFile/FormatFile.md +22 -22
- package/dist/docs/FormatRelativeDateTime/FormatRelativeDateTime.md +1 -1
- package/dist/docs/FormatTime/FormatTime.md +1 -1
- package/dist/docs/Gallery/Gallery.md +1 -1
- package/dist/docs/Glimmer/Glimmer.md +7 -7
- package/dist/docs/Grid/Grid.md +2 -2
- package/dist/docs/Heading/Heading.md +2 -2
- package/dist/docs/Icon/Icon.md +1 -1
- package/dist/docs/InlineLabel/InlineLabel.md +1 -1
- package/dist/docs/InputDate/InputDate.md +4 -4
- package/dist/docs/InputEmail/InputEmail.md +3 -3
- package/dist/docs/InputFile/InputFile.md +7 -7
- package/dist/docs/InputNumber/InputNumber.md +5 -5
- package/dist/docs/InputPassword/InputPassword.md +3 -3
- package/dist/docs/InputPhoneNumber/InputPhoneNumber.md +2 -2
- package/dist/docs/InputText/InputText.md +7 -7
- package/dist/docs/InputTime/InputTime.md +2 -2
- package/dist/docs/LightBox/LightBox.md +17 -17
- package/dist/docs/Menu/Menu.md +122 -0
- package/dist/docs/Modal/Modal.md +1 -1
- package/dist/docs/MultiSelect/MultiSelect.md +1 -1
- package/dist/docs/Page/Page.md +9 -9
- package/dist/docs/Popover/Popover.md +11 -11
- package/dist/docs/ProgressBar/ProgressBar.md +1 -1
- package/dist/docs/RadioGroup/RadioGroup.md +1 -1
- package/dist/docs/SegmentedControl/SegmentedControl.md +2 -2
- package/dist/docs/Select/Select.md +4 -4
- package/dist/docs/SideKick/SideKick.md +1 -1
- package/dist/docs/Spinner/Spinner.md +1 -1
- package/dist/docs/Text/Text.md +3 -3
- package/dist/docs/Toast/Toast.md +1 -1
- package/package.json +2 -2
|
@@ -42,7 +42,7 @@ decision on whether to show or hide the units.
|
|
|
42
42
|
|
|
43
43
|
| Prop | Type | Required | Default | Description |
|
|
44
44
|
|------|------|----------|---------|-------------|
|
|
45
|
-
| `date` | `
|
|
45
|
+
| `date` | `Date | number | string` | Yes | — | The date that is being counted down to. Value for date as a `string` should be in ISO 8601 format. |
|
|
46
46
|
| `granularity` | `GranularityOptions` | No | `dhms` | Defines the time format presented (e.g., dhms will show days, hours, minutes, and seconds) |
|
|
47
47
|
| `onComplete` | `() => void` | No | — | Callback when the countdown is done |
|
|
48
48
|
| `showUnits` | `boolean` | No | — | Whether or not to present the unit of time to the user, or just the raw numbers. |
|
|
@@ -520,7 +520,7 @@ objects that will define the sorting options for the column.
|
|
|
520
520
|
| `headers` | `DataListHeader<T>` | Yes | — | The header of the DataList. The object keys are determined by the keys in the data. |
|
|
521
521
|
| `filtered` | `boolean` | No | — | Adjusts the DataList to show the UX when it is filtered. |
|
|
522
522
|
| `headerVisibility` | `{ xs?: boolean; sm?: boolean; md?: boolean; lg?: boolean; xl?: boolean; }` | No | `{ xs: true, sm: true, md: true, lg: true, xl: true }` | Determine if the header is visible at a given breakpoint. If one isn't provided, it will use the value from the next ... |
|
|
523
|
-
| `loadingState` | `"
|
|
523
|
+
| `loadingState` | `"filtering" | "initial" | "loadingMore" | "none"` | No | — | Set the loading state of the DataList. There are a few guidelines on when to use what. - `"initial"` - loading the f... |
|
|
524
524
|
| `onLoadMore` | `() => void` | No | — | The callback function when the user scrolls to the bottom of the list. |
|
|
525
525
|
| `onSelect` | `(selected: DataListSelectedType<T["id"]>) => void` | No | — | Callback when an item checkbox is clicked. |
|
|
526
526
|
| `onSelectAll` | `(selected: DataListSelectedType<T["id"]>) => void` | No | — | Callback when the select all checkbox is clicked. |
|
|
@@ -529,23 +529,31 @@ objects that will define the sorting options for the column.
|
|
|
529
529
|
| `title` | `string` | No | — | The title of the DataList. |
|
|
530
530
|
| `totalCount` | `number` | No | — | Total number of items in the DataList. This renders an "N results" text with the DataList that helps users know how ... |
|
|
531
531
|
|
|
532
|
-
#### DataList.
|
|
532
|
+
#### DataList.BatchAction
|
|
533
533
|
|
|
534
534
|
| Prop | Type | Required | Default | Description |
|
|
535
535
|
|------|------|----------|---------|-------------|
|
|
536
|
-
| `
|
|
537
|
-
| `
|
|
538
|
-
| `
|
|
539
|
-
| `
|
|
536
|
+
| `label` | `string | ((item: DataListObject) => string)` | Yes | — | The label of the action |
|
|
537
|
+
| `actionUrl` | `string` | No | — | The URL to navigate to when the action is clicked. |
|
|
538
|
+
| `alwaysVisible` | `boolean` | No | — | Determine if the action is always visible. It is not recommended to set this to true on more then one action. |
|
|
539
|
+
| `destructive` | `boolean` | No | — | Adjust the styling of an action label and icon to be more destructive. |
|
|
540
|
+
| `icon` | `IconNames` | No | — | The icon beside the label |
|
|
541
|
+
| `onClick` | `() => void` | No | — | The callback function when the action is clicked. |
|
|
540
542
|
|
|
541
|
-
#### DataList.
|
|
543
|
+
#### DataList.BatchActions
|
|
542
544
|
|
|
543
545
|
| Prop | Type | Required | Default | Description |
|
|
544
546
|
|------|------|----------|---------|-------------|
|
|
545
|
-
| `
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
547
|
+
| `children` | `Fragment<ReactElement<DataListBulkActionProps, string | JSXElementConstructor<any>>>` | No | — | The actions to render on the top of the DataList to make actions to multiple items. This only accepts the DataList.Ba... |
|
|
548
|
+
|
|
549
|
+
#### DataList.EmptyState
|
|
550
|
+
|
|
551
|
+
| Prop | Type | Required | Default | Description |
|
|
552
|
+
|------|------|----------|---------|-------------|
|
|
553
|
+
| `message` | `string` | Yes | — | The message that shows when the DataList is empty. |
|
|
554
|
+
| `action` | `ReactElement<{ onClick?: never; external?: never; readonly name?: string; submit: never; readonly type?: ButtonType; readonly value?: string; readonly size?: ButtonSize; readonly ariaLabel?: string; ... 17 more ...; readonly children?: never; } | ... 34 more ... | { ...; }, string | JSXElementConstructor<...>>` | No | — | The action that shows when the DataList is empty. This only accepts a Button component. Adding a non-Button componen... |
|
|
555
|
+
| `customRender` | `(emptyState: Omit<DataListEmptyStateProps, "customRender">) => ReactNode` | No | — | Custom render function for the empty state. If provided, this function will be used to render the empty state instea... |
|
|
556
|
+
| `type` | `"empty" | "filtered"` | No | — | Determine the type of empty state to show. By default, it will show the "empty" state when there is no data. If you ... |
|
|
549
557
|
|
|
550
558
|
#### DataList.ItemActions
|
|
551
559
|
|
|
@@ -557,19 +565,11 @@ objects that will define the sorting options for the column.
|
|
|
557
565
|
| `to` | `string | ((item: T) => string)` | No | — | If a React Navigation is needed, use this prop to use the `Link` component that comes with React Router. |
|
|
558
566
|
| `url` | `string | ((item: T) => string)` | No | — | If a normal page navigation is needed, use this prop to change the element to an `a` tag with an `href`. |
|
|
559
567
|
|
|
560
|
-
#### DataList.
|
|
561
|
-
|
|
562
|
-
| Prop | Type | Required | Default | Description |
|
|
563
|
-
|------|------|----------|---------|-------------|
|
|
564
|
-
| `children` | `Fragment<ReactElement<DataListBulkActionProps, string | JSXElementConstructor<any>>>` | No | — | The actions to render on the top of the DataList to make actions to multiple items. This only accepts the DataList.Ba... |
|
|
565
|
-
|
|
566
|
-
#### DataList.BatchAction
|
|
568
|
+
#### DataList.Search
|
|
567
569
|
|
|
568
570
|
| Prop | Type | Required | Default | Description |
|
|
569
571
|
|------|------|----------|---------|-------------|
|
|
570
|
-
| `
|
|
571
|
-
| `
|
|
572
|
-
| `
|
|
573
|
-
| `
|
|
574
|
-
| `icon` | `IconNames` | No | — | The icon beside the label |
|
|
575
|
-
| `onClick` | `() => void` | No | — | The callback function when the action is clicked. |
|
|
572
|
+
| `onSearch` | `(value: string) => void` | Yes | — | |
|
|
573
|
+
| `initialValue` | `string` | No | — | The initial value of the search input. Updating this prop after the component has mounted will rerender the componen... |
|
|
574
|
+
| `placeholder` | `string` | No | — | The placeholder text for the search input. This either uses the title prop prepended by "Search" or just falls back t... |
|
|
575
|
+
| `value` | `string` | No | — | The controlled value of the search input. Supply this field if you want to take control over the search input's valu... |
|
|
@@ -511,11 +511,14 @@ const table = useReactTable({
|
|
|
511
511
|
| `sorting` | `SortingType` | No | — | Enables sorting, mostly follows: https://tanstack.com/table/v8/docs/api/features/sorting#table-options |
|
|
512
512
|
| `stickyHeader` | `boolean` | No | — | When set to true makes the header sticky while scrolling vertically |
|
|
513
513
|
|
|
514
|
-
#### DataTable.
|
|
514
|
+
#### DataTable.PaginationButton
|
|
515
515
|
|
|
516
516
|
| Prop | Type | Required | Default | Description |
|
|
517
517
|
|------|------|----------|---------|-------------|
|
|
518
|
-
| `
|
|
518
|
+
| `ariaLabel` | `(direction: "next" | "previous") => string` | Yes | — | Function that returns the aria-label for the button. Required for accessibility. Should return translated strings bas... |
|
|
519
|
+
| `direction` | `"next" | "previous"` | Yes | — | The direction of the pagination button |
|
|
520
|
+
| `disabled` | `boolean` | No | `false` | Whether the pagination button is disabled |
|
|
521
|
+
| `onClick` | `() => void` | No | — | Callback function when the pagination button is clicked |
|
|
519
522
|
|
|
520
523
|
#### DataTable.RowActions
|
|
521
524
|
|
|
@@ -531,11 +534,8 @@ const table = useReactTable({
|
|
|
531
534
|
| `direction` | `SortDirection` | No | — | The current sort direction for this column. When undefined, the header renders as non-interactive. |
|
|
532
535
|
| `onSort` | `() => void` | No | — | Callback function triggered when the sortable header is clicked. When undefined, the header renders as non-interactive. |
|
|
533
536
|
|
|
534
|
-
#### DataTable.
|
|
537
|
+
#### DataTable.Table
|
|
535
538
|
|
|
536
539
|
| Prop | Type | Required | Default | Description |
|
|
537
540
|
|------|------|----------|---------|-------------|
|
|
538
|
-
| `
|
|
539
|
-
| `direction` | `"next" | "previous"` | Yes | — | The direction of the pagination button |
|
|
540
|
-
| `disabled` | `boolean` | No | `false` | Whether the pagination button is disabled |
|
|
541
|
-
| `onClick` | `() => void` | No | — | Callback function when the pagination button is clicked |
|
|
541
|
+
| `layout` | `"auto" | "fixed"` | No | — | Controls the table layout. - `auto` (default): Columns size to content. - `fixed`: Column widths can be set explicitl... |
|
|
@@ -80,7 +80,7 @@ through inline styles.
|
|
|
80
80
|
| Prop | Type | Required | Default | Description |
|
|
81
81
|
|------|------|----------|---------|-------------|
|
|
82
82
|
| `direction` | `"horizontal" | "vertical"` | No | `horizontal` | The direction of the divider |
|
|
83
|
-
| `size` | `"
|
|
83
|
+
| `size` | `"base" | "large" | "larger" | "largest"` | No | `base` | The weight of the divider. |
|
|
84
84
|
| `testID` | `string` | No | — | A reference to the element in the rendered output |
|
|
85
85
|
| `UNSAFE_className` | `{ readonly container?: string; }` | No | — | **Use at your own risk:** Custom classNames for specific elements. This should only be used as a **last resort**. Usi... |
|
|
86
86
|
| `UNSAFE_style` | `{ readonly container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
package/dist/docs/Flex/Flex.md
CHANGED
|
@@ -35,4 +35,4 @@ one-directional layout.
|
|
|
35
35
|
| `template` | `ColumnKeys[]` | Yes | — | Determine how the children gets laid out **Supported keys** - `"grow"` - Grows to the space available. If all childr... |
|
|
36
36
|
| `align` | `"center" | "end" | "start"` | No | `center` | Adjusts the alignment of the Flex children. |
|
|
37
37
|
| `direction` | `Direction` | No | `row` | The direction of the content. |
|
|
38
|
-
| `gap` | `"
|
|
38
|
+
| `gap` | `"base" | "extravagant" | "large" | "larger" | "largest" | "minuscule" | "none" | "slim" | "small" | "smaller" | "smallest"` | No | `base` | The spacing between the children. |
|
package/dist/docs/Form/Form.md
CHANGED
|
@@ -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<
|
|
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` | `
|
|
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` | `
|
|
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` | `"
|
|
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` | `"
|
|
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` | `"
|
|
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` | `
|
|
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` | `
|
|
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` | `"
|
|
35
|
-
| `displaySize` | `"
|
|
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.
|
|
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
|
-
| `
|
|
46
|
+
| `onClick` | `MouseEventHandler<HTMLButtonElement | HTMLDivElement>` | No | — | |
|
|
47
|
+
| `tabIndex` | `number` | No | — | |
|
|
48
|
+
| `type` | `"button" | "reset" | "submit"` | No | — | |
|
|
52
49
|
|
|
53
|
-
#### FormatFile.
|
|
50
|
+
#### FormatFile.DeleteButton
|
|
54
51
|
|
|
55
52
|
| Prop | Type | Required | Default | Description |
|
|
56
53
|
|------|------|----------|---------|-------------|
|
|
57
|
-
| `
|
|
54
|
+
| `onDelete` | `(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void` | No | — | |
|
|
58
55
|
|
|
59
|
-
#### FormatFile.
|
|
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
|
-
| `
|
|
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.
|
|
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.
|
|
78
|
+
#### FormatFile.ThumbnailContainer
|
|
85
79
|
|
|
86
80
|
| Prop | Type | Required | Default | Description |
|
|
87
81
|
|------|------|----------|---------|-------------|
|
|
88
|
-
| `
|
|
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` | `
|
|
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` | `
|
|
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` | `"
|
|
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` | `"
|
|
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... |
|