@jobber/components 7.9.0 → 7.10.0
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/InputTime/InputTime.rebuilt.d.ts +1 -1
- package/dist/InputTime/InputTime.types.d.ts +8 -0
- package/dist/InputTime/index.cjs +14 -9
- package/dist/InputTime/index.mjs +14 -9
- package/dist/InputTime/utils/input-time-utils.d.ts +1 -1
- package/dist/docs/AnimatedSwitcher/AnimatedSwitcher.md +1 -1
- package/dist/docs/Banner/Banner.md +4 -4
- package/dist/docs/Box/Box.md +6 -6
- package/dist/docs/Button/Button.md +3 -3
- package/dist/docs/Card/Card.md +2 -2
- package/dist/docs/Checkbox/Checkbox.md +2 -2
- package/dist/docs/Chip/Chip.md +1 -1
- package/dist/docs/Chips/Chips.md +1 -1
- package/dist/docs/Cluster/Cluster.md +2 -2
- package/dist/docs/Combobox/Combobox.md +1 -1
- package/dist/docs/ConfirmationModal/ConfirmationModal.md +1 -1
- package/dist/docs/Content/Content.md +2 -2
- package/dist/docs/ContentBlock/ContentBlock.md +2 -2
- package/dist/docs/DataList/DataList.md +2 -2
- package/dist/docs/Divider/Divider.md +1 -1
- package/dist/docs/Emphasis/Emphasis.md +1 -1
- package/dist/docs/Flex/Flex.md +2 -2
- package/dist/docs/Form/Form.md +1 -1
- package/dist/docs/FormField/FormField.md +1 -1
- package/dist/docs/FormatFile/FormatFile.md +2 -2
- package/dist/docs/Gallery/Gallery.md +1 -1
- package/dist/docs/Glimmer/Glimmer.md +2 -2
- package/dist/docs/Grid/Grid.md +1 -1
- package/dist/docs/Heading/Heading.md +2 -2
- package/dist/docs/Icon/Icon.md +2 -2
- package/dist/docs/InlineLabel/InlineLabel.md +1 -1
- package/dist/docs/InputDate/InputDate.md +3 -3
- package/dist/docs/InputFile/InputFile.md +10 -10
- package/dist/docs/InputNumber/InputNumber.md +1 -1
- package/dist/docs/Menu/Menu.md +1 -1
- package/dist/docs/Modal/Modal.md +4 -4
- package/dist/docs/Popover/Popover.md +2 -2
- package/dist/docs/ProgressBar/ProgressBar.md +1 -1
- package/dist/docs/RadioGroup/RadioGroup.md +1 -1
- package/dist/docs/SegmentedControl/SegmentedControl.md +1 -1
- package/dist/docs/Select/Select.md +2 -2
- package/dist/docs/Stack/Stack.md +2 -2
- package/dist/docs/StatusLabel/StatusLabel.md +1 -1
- package/dist/docs/Text/Text.md +4 -4
- package/dist/docs/Tiles/Tiles.md +1 -1
- package/package.json +2 -2
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
import React from "react";
|
|
2
2
|
import type { InputTimeRebuiltProps } from "./InputTime.types";
|
|
3
|
-
export declare function InputTimeRebuilt({ value, onChange, readOnly, autoComplete, inputRef, ...props }: InputTimeRebuiltProps): React.JSX.Element;
|
|
3
|
+
export declare function InputTimeRebuilt({ value, onChange, readOnly, autoComplete, inputRef, step, ...props }: InputTimeRebuiltProps): React.JSX.Element;
|
|
@@ -32,6 +32,14 @@ export interface InputTimeRebuiltProps extends Omit<HTMLInputBaseProps, "maxLeng
|
|
|
32
32
|
* Minimum numerical or date value.
|
|
33
33
|
*/
|
|
34
34
|
readonly min?: number;
|
|
35
|
+
/**
|
|
36
|
+
* Granularity of the time input, in seconds. Matches the native HTML `step`
|
|
37
|
+
* attribute. Defaults to `60` so the input displays only hours and minutes;
|
|
38
|
+
* set to a value less than `60` (e.g. `1`) to display seconds.
|
|
39
|
+
*
|
|
40
|
+
* @default 60
|
|
41
|
+
*/
|
|
42
|
+
readonly step?: number;
|
|
35
43
|
readonly inputRef?: Ref<HTMLInputElement>;
|
|
36
44
|
/**
|
|
37
45
|
* @deprecated Use `onKeyDown` or `onKeyUp` instead.
|
package/dist/InputTime/index.cjs
CHANGED
|
@@ -173,32 +173,37 @@ function formatHour(time) {
|
|
|
173
173
|
return `${time}:00`;
|
|
174
174
|
}
|
|
175
175
|
|
|
176
|
-
function dateToTimeString(date) {
|
|
176
|
+
function dateToTimeString(date, includeSeconds = false) {
|
|
177
177
|
if (!(date instanceof Date)) {
|
|
178
178
|
return "";
|
|
179
179
|
}
|
|
180
|
-
// Extract hours and minutes from the Date object
|
|
181
180
|
const hours = date.getHours().toString().padStart(2, "0");
|
|
182
181
|
const minutes = date.getMinutes().toString().padStart(2, "0");
|
|
183
|
-
|
|
182
|
+
if (includeSeconds) {
|
|
183
|
+
const seconds = date.getSeconds().toString().padStart(2, "0");
|
|
184
|
+
return `${hours}:${minutes}:${seconds}`;
|
|
185
|
+
}
|
|
184
186
|
return `${hours}:${minutes}`;
|
|
185
187
|
}
|
|
186
188
|
function timeStringToDate(timeString, baseDate) {
|
|
187
189
|
try {
|
|
188
|
-
const [hours, minutes] = timeString.split(":").map(Number);
|
|
190
|
+
const [hours, minutes, seconds = 0] = timeString.split(":").map(Number);
|
|
189
191
|
if (isNaN(hours) ||
|
|
190
192
|
isNaN(minutes) ||
|
|
193
|
+
isNaN(seconds) ||
|
|
191
194
|
hours < 0 ||
|
|
192
195
|
hours > 24 ||
|
|
193
196
|
minutes < 0 ||
|
|
194
|
-
minutes > 60
|
|
197
|
+
minutes > 60 ||
|
|
198
|
+
seconds < 0 ||
|
|
199
|
+
seconds > 60) {
|
|
195
200
|
return undefined;
|
|
196
201
|
}
|
|
197
202
|
// Try to preserve the Date part of the Date object as long as it is valid
|
|
198
203
|
const date = baseDate instanceof Date && !isNaN(baseDate.getTime())
|
|
199
204
|
? new Date(baseDate)
|
|
200
205
|
: new Date();
|
|
201
|
-
date.setHours(hours, minutes,
|
|
206
|
+
date.setHours(hours, minutes, seconds, 0);
|
|
202
207
|
return date;
|
|
203
208
|
}
|
|
204
209
|
catch (_a) {
|
|
@@ -268,7 +273,7 @@ function useInputTimeActions({ onChange, value, inputRef, onFocus, onBlur, onKey
|
|
|
268
273
|
|
|
269
274
|
function InputTimeRebuilt(_a) {
|
|
270
275
|
var _b;
|
|
271
|
-
var { value, onChange, readOnly, autoComplete, inputRef } = _a, props = tslib_es6.__rest(_a, ["value", "onChange", "readOnly", "autoComplete", "inputRef"]);
|
|
276
|
+
var { value, onChange, readOnly, autoComplete, inputRef, step = 60 } = _a, props = tslib_es6.__rest(_a, ["value", "onChange", "readOnly", "autoComplete", "inputRef", "step"]);
|
|
272
277
|
const { internalRef, mergedRef, wrapperRef } = useInputTimeRefs(inputRef);
|
|
273
278
|
const generatedId = React.useId();
|
|
274
279
|
const id = props.id || generatedId;
|
|
@@ -303,8 +308,8 @@ function InputTimeRebuilt(_a) {
|
|
|
303
308
|
const descriptionIdentifier = `descriptionUUID--${id}`;
|
|
304
309
|
const descriptionVisible = props.description && !props.inline;
|
|
305
310
|
const isInvalid = Boolean(props.error || props.invalid);
|
|
306
|
-
return (React.createElement(mergeRefs.FormFieldWrapper, { disabled: props.disabled, size: props.size, align: props.align, inline: props.inline, name: props.name, error: props.error || "", identifier: id, descriptionIdentifier: descriptionIdentifier, invalid: props.invalid, description: props.description, clearable: (_b = props.clearable) !== null && _b !== void 0 ? _b : "never", onClear: handleClear, type: "time", readonly: readOnly, placeholder: props.placeholder, value: dateToTimeString(value), wrapperRef: wrapperRef },
|
|
307
|
-
React.createElement("input", Object.assign({ ref: mergedRef, type: "time", name: props.name, className: mergeRefs.formFieldStyles.input, id: id, disabled: props.disabled, readOnly: readOnly, autoComplete: autoComplete, autoFocus: props.autoFocus, required: props.required, max: props.max, min: props.min, value: dateToTimeString(value), onChange: handleChangeEvent, onBlur: handleBlur, onFocus: handleFocus, onKeyDown: handleKeyDown, onKeyUp: handleKeyUp, onClick: handleClick, onMouseDown: handleMouseDown, onMouseUp: handleMouseUp, onPointerDown: handlePointerDown, onPointerUp: handlePointerUp, "data-testid": "ATL-InputTime-input", "aria-label": props["aria-label"], "aria-describedby": descriptionVisible ? descriptionIdentifier : props["aria-describedby"], "aria-invalid": isInvalid ? true : undefined, "aria-required": props["aria-required"] }, dataAttrs))));
|
|
311
|
+
return (React.createElement(mergeRefs.FormFieldWrapper, { disabled: props.disabled, size: props.size, align: props.align, inline: props.inline, name: props.name, error: props.error || "", identifier: id, descriptionIdentifier: descriptionIdentifier, invalid: props.invalid, description: props.description, clearable: (_b = props.clearable) !== null && _b !== void 0 ? _b : "never", onClear: handleClear, type: "time", readonly: readOnly, placeholder: props.placeholder, value: dateToTimeString(value, step % 60 !== 0), wrapperRef: wrapperRef },
|
|
312
|
+
React.createElement("input", Object.assign({ ref: mergedRef, type: "time", name: props.name, className: mergeRefs.formFieldStyles.input, id: id, disabled: props.disabled, readOnly: readOnly, autoComplete: autoComplete, autoFocus: props.autoFocus, required: props.required, max: props.max, min: props.min, step: step, value: dateToTimeString(value, step % 60 !== 0), onChange: handleChangeEvent, onBlur: handleBlur, onFocus: handleFocus, onKeyDown: handleKeyDown, onKeyUp: handleKeyUp, onClick: handleClick, onMouseDown: handleMouseDown, onMouseUp: handleMouseUp, onPointerDown: handlePointerDown, onPointerUp: handlePointerUp, "data-testid": "ATL-InputTime-input", "aria-label": props["aria-label"], "aria-describedby": descriptionVisible ? descriptionIdentifier : props["aria-describedby"], "aria-invalid": isInvalid ? true : undefined, "aria-required": props["aria-required"] }, dataAttrs))));
|
|
308
313
|
}
|
|
309
314
|
function useInputTimeRefs(inputRef) {
|
|
310
315
|
const internalRef = React.useRef(null);
|
package/dist/InputTime/index.mjs
CHANGED
|
@@ -171,32 +171,37 @@ function formatHour(time) {
|
|
|
171
171
|
return `${time}:00`;
|
|
172
172
|
}
|
|
173
173
|
|
|
174
|
-
function dateToTimeString(date) {
|
|
174
|
+
function dateToTimeString(date, includeSeconds = false) {
|
|
175
175
|
if (!(date instanceof Date)) {
|
|
176
176
|
return "";
|
|
177
177
|
}
|
|
178
|
-
// Extract hours and minutes from the Date object
|
|
179
178
|
const hours = date.getHours().toString().padStart(2, "0");
|
|
180
179
|
const minutes = date.getMinutes().toString().padStart(2, "0");
|
|
181
|
-
|
|
180
|
+
if (includeSeconds) {
|
|
181
|
+
const seconds = date.getSeconds().toString().padStart(2, "0");
|
|
182
|
+
return `${hours}:${minutes}:${seconds}`;
|
|
183
|
+
}
|
|
182
184
|
return `${hours}:${minutes}`;
|
|
183
185
|
}
|
|
184
186
|
function timeStringToDate(timeString, baseDate) {
|
|
185
187
|
try {
|
|
186
|
-
const [hours, minutes] = timeString.split(":").map(Number);
|
|
188
|
+
const [hours, minutes, seconds = 0] = timeString.split(":").map(Number);
|
|
187
189
|
if (isNaN(hours) ||
|
|
188
190
|
isNaN(minutes) ||
|
|
191
|
+
isNaN(seconds) ||
|
|
189
192
|
hours < 0 ||
|
|
190
193
|
hours > 24 ||
|
|
191
194
|
minutes < 0 ||
|
|
192
|
-
minutes > 60
|
|
195
|
+
minutes > 60 ||
|
|
196
|
+
seconds < 0 ||
|
|
197
|
+
seconds > 60) {
|
|
193
198
|
return undefined;
|
|
194
199
|
}
|
|
195
200
|
// Try to preserve the Date part of the Date object as long as it is valid
|
|
196
201
|
const date = baseDate instanceof Date && !isNaN(baseDate.getTime())
|
|
197
202
|
? new Date(baseDate)
|
|
198
203
|
: new Date();
|
|
199
|
-
date.setHours(hours, minutes,
|
|
204
|
+
date.setHours(hours, minutes, seconds, 0);
|
|
200
205
|
return date;
|
|
201
206
|
}
|
|
202
207
|
catch (_a) {
|
|
@@ -266,7 +271,7 @@ function useInputTimeActions({ onChange, value, inputRef, onFocus, onBlur, onKey
|
|
|
266
271
|
|
|
267
272
|
function InputTimeRebuilt(_a) {
|
|
268
273
|
var _b;
|
|
269
|
-
var { value, onChange, readOnly, autoComplete, inputRef } = _a, props = __rest(_a, ["value", "onChange", "readOnly", "autoComplete", "inputRef"]);
|
|
274
|
+
var { value, onChange, readOnly, autoComplete, inputRef, step = 60 } = _a, props = __rest(_a, ["value", "onChange", "readOnly", "autoComplete", "inputRef", "step"]);
|
|
270
275
|
const { internalRef, mergedRef, wrapperRef } = useInputTimeRefs(inputRef);
|
|
271
276
|
const generatedId = useId();
|
|
272
277
|
const id = props.id || generatedId;
|
|
@@ -301,8 +306,8 @@ function InputTimeRebuilt(_a) {
|
|
|
301
306
|
const descriptionIdentifier = `descriptionUUID--${id}`;
|
|
302
307
|
const descriptionVisible = props.description && !props.inline;
|
|
303
308
|
const isInvalid = Boolean(props.error || props.invalid);
|
|
304
|
-
return (React__default.createElement(FormFieldWrapper, { disabled: props.disabled, size: props.size, align: props.align, inline: props.inline, name: props.name, error: props.error || "", identifier: id, descriptionIdentifier: descriptionIdentifier, invalid: props.invalid, description: props.description, clearable: (_b = props.clearable) !== null && _b !== void 0 ? _b : "never", onClear: handleClear, type: "time", readonly: readOnly, placeholder: props.placeholder, value: dateToTimeString(value), wrapperRef: wrapperRef },
|
|
305
|
-
React__default.createElement("input", Object.assign({ ref: mergedRef, type: "time", name: props.name, className: formFieldStyles.input, id: id, disabled: props.disabled, readOnly: readOnly, autoComplete: autoComplete, autoFocus: props.autoFocus, required: props.required, max: props.max, min: props.min, value: dateToTimeString(value), onChange: handleChangeEvent, onBlur: handleBlur, onFocus: handleFocus, onKeyDown: handleKeyDown, onKeyUp: handleKeyUp, onClick: handleClick, onMouseDown: handleMouseDown, onMouseUp: handleMouseUp, onPointerDown: handlePointerDown, onPointerUp: handlePointerUp, "data-testid": "ATL-InputTime-input", "aria-label": props["aria-label"], "aria-describedby": descriptionVisible ? descriptionIdentifier : props["aria-describedby"], "aria-invalid": isInvalid ? true : undefined, "aria-required": props["aria-required"] }, dataAttrs))));
|
|
309
|
+
return (React__default.createElement(FormFieldWrapper, { disabled: props.disabled, size: props.size, align: props.align, inline: props.inline, name: props.name, error: props.error || "", identifier: id, descriptionIdentifier: descriptionIdentifier, invalid: props.invalid, description: props.description, clearable: (_b = props.clearable) !== null && _b !== void 0 ? _b : "never", onClear: handleClear, type: "time", readonly: readOnly, placeholder: props.placeholder, value: dateToTimeString(value, step % 60 !== 0), wrapperRef: wrapperRef },
|
|
310
|
+
React__default.createElement("input", Object.assign({ ref: mergedRef, type: "time", name: props.name, className: formFieldStyles.input, id: id, disabled: props.disabled, readOnly: readOnly, autoComplete: autoComplete, autoFocus: props.autoFocus, required: props.required, max: props.max, min: props.min, step: step, value: dateToTimeString(value, step % 60 !== 0), onChange: handleChangeEvent, onBlur: handleBlur, onFocus: handleFocus, onKeyDown: handleKeyDown, onKeyUp: handleKeyUp, onClick: handleClick, onMouseDown: handleMouseDown, onMouseUp: handleMouseUp, onPointerDown: handlePointerDown, onPointerUp: handlePointerUp, "data-testid": "ATL-InputTime-input", "aria-label": props["aria-label"], "aria-describedby": descriptionVisible ? descriptionIdentifier : props["aria-describedby"], "aria-invalid": isInvalid ? true : undefined, "aria-required": props["aria-required"] }, dataAttrs))));
|
|
306
311
|
}
|
|
307
312
|
function useInputTimeRefs(inputRef) {
|
|
308
313
|
const internalRef = useRef(null);
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare function dateToTimeString(date?: Date): string;
|
|
1
|
+
export declare function dateToTimeString(date?: Date, includeSeconds?: boolean): string;
|
|
2
2
|
export declare function timeStringToDate(timeString: string, baseDate?: Date): Date | undefined;
|
|
@@ -23,7 +23,7 @@ initial icon. See
|
|
|
23
23
|
| `initialChild` | `ReactElement<unknown, string | JSXElementConstructor<any>>` | Yes | — | The component that shows up when the `switched` prop is `false` |
|
|
24
24
|
| `switched` | `boolean` | Yes | `false` | Determines when to switch the component to the `switchTo` prop. |
|
|
25
25
|
| `switchTo` | `ReactElement<unknown, string | JSXElementConstructor<any>>` | Yes | — | The component that shows up when the `switched` prop is `true` |
|
|
26
|
-
| `type` | `"
|
|
26
|
+
| `type` | `"fade" | "slideFromBottom"` | No | `slideFromBottom` | Change the transition between 2 elements. |
|
|
27
27
|
|
|
28
28
|
#### AnimatedSwitcher.Icon
|
|
29
29
|
|
|
@@ -389,7 +389,7 @@ Use `UNSAFE_style` to apply inline custom styles to the Banner.
|
|
|
389
389
|
| `dismissible` | `boolean` | No | `true` | Set to false to hide the dismiss button |
|
|
390
390
|
| `icon` | `IconNames` | No | — | Use to override the default status Icon |
|
|
391
391
|
| `onDismiss` | `() => void` | No | — | Callback to be called when the Banner is dismissed. |
|
|
392
|
-
| `primaryAction` | `{
|
|
392
|
+
| `primaryAction` | `{ onClick?: never; external?: never; readonly name?: string; submit: never; readonly type?: ButtonType; readonly value?: string; readonly size?: ButtonSize; readonly ariaLabel?: string; ... 17 more ...; readonly children?: never; } | ... 34 more ... | { ...; }` | No | — | Accepts props for Button. Default action uses a 'subtle' Button |
|
|
393
393
|
|
|
394
394
|
#### Banner.Provider
|
|
395
395
|
|
|
@@ -407,11 +407,11 @@ Use `UNSAFE_style` to apply inline custom styles to the Banner.
|
|
|
407
407
|
|
|
408
408
|
| Prop | Type | Required | Default | Description |
|
|
409
409
|
|------|------|----------|---------|-------------|
|
|
410
|
-
| `backgroundColor` | `"
|
|
411
|
-
| `color` | `"
|
|
410
|
+
| `backgroundColor` | `"event" | "invoice" | "job" | "quote" | "request" | "task" | "text" | "visit" | "warning" | "icon" | "disabled" | "success" | "base-grey--100" | "base-grey--200" | "base-grey--300" | ... 269 more ... | "client--onSurface"` | No | — | Sets the background color of the icon. |
|
|
411
|
+
| `color` | `"task" | "text" | "warning" | "icon" | "disabled" | "success" | "blue" | "green" | "yellow" | "red" | "grey" | "white" | "greyBlue" | "lightBlue" | "orange" | "navy" | "interactive" | ... 32 more ... | "brandHighlight"` | No | — | Determines the color of the icon. Some icons have a default system colour like quotes, jobs, and invoices. Others tha... |
|
|
412
412
|
| `customColor` | `string` | No | — | Sets a custom color for the icon. Can be a rgb() or hex value. |
|
|
413
413
|
| `name` | `IconNames` | No | — | The icon to show. |
|
|
414
|
-
| `size` | `"small" | "
|
|
414
|
+
| `size` | `"small" | "large" | "base"` | No | `base` | Changes the size to small or large. |
|
|
415
415
|
| `testID` | `string` | No | — | Used to locate this view in end-to-end tests |
|
|
416
416
|
| `UNSAFE_className` | `{ readonly container?: string; readonly icon?: { svg?: string; path?: string; }; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
417
417
|
| `UNSAFE_style` | `{ readonly container?: CSSProperties; readonly icon?: { svg?: CSSProperties; path?: CSSProperties; }; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
package/dist/docs/Box/Box.md
CHANGED
|
@@ -206,18 +206,18 @@ defaults to respecting theme/modes.
|
|
|
206
206
|
| `alignItems` | `AlignItems` | No | — | This feature is well established and works across many devices and browser versions. It’s been available across brows... |
|
|
207
207
|
| `alignSelf` | `AlignSelf` | No | — | This feature is well established and works across many devices and browser versions. It’s been available across brows... |
|
|
208
208
|
| `as` | `"div" | "span" | "section" | "article" | "aside" | "main"` | No | `div` | |
|
|
209
|
-
| `background` | `"
|
|
209
|
+
| `background` | `"event" | "invoice" | "job" | "quote" | "request" | "task" | "text" | "visit" | "warning" | "icon" | "disabled" | "success" | "base-grey--100" | "base-grey--200" | "base-grey--300" | ... 269 more ... | "client--onSurface"` | No | — | |
|
|
210
210
|
| `border` | `"base" | "thick" | "thicker" | "thickest" | BoxBorderWidth` | No | — | |
|
|
211
|
-
| `borderColor` | `"
|
|
211
|
+
| `borderColor` | `"event" | "invoice" | "job" | "quote" | "request" | "task" | "text" | "visit" | "warning" | "icon" | "disabled" | "success" | "base-grey--100" | "base-grey--200" | "base-grey--300" | ... 269 more ... | "client--onSurface"` | No | — | |
|
|
212
212
|
| `direction` | `FlexDirection` | No | — | |
|
|
213
|
-
| `gap` | `"
|
|
213
|
+
| `gap` | `"small" | "large" | "base" | "minuscule" | "smallest" | "smaller" | "slim" | "larger" | "largest" | "extravagant"` | No | — | |
|
|
214
214
|
| `height` | `BoxDimension` | No | `auto` | |
|
|
215
215
|
| `justifyContent` | `JustifyContent` | No | — | This feature is well established and works across many devices and browser versions. It’s been available across brows... |
|
|
216
|
-
| `margin` | `"
|
|
216
|
+
| `margin` | `"small" | "large" | "base" | "minuscule" | "smallest" | "smaller" | "slim" | "larger" | "largest" | "extravagant" | BoxSpace` | No | — | |
|
|
217
217
|
| `overflow` | `Overflow` | No | — | This feature is well established and works across many devices and browser versions. It’s been available across brows... |
|
|
218
|
-
| `padding` | `"
|
|
218
|
+
| `padding` | `"small" | "large" | "base" | "minuscule" | "smallest" | "smaller" | "slim" | "larger" | "largest" | "extravagant" | BoxSpace` | No | — | |
|
|
219
219
|
| `position` | `Position` | No | `relative` | This feature is well established and works across many devices and browser versions. It’s been available across brows... |
|
|
220
220
|
| `preserveWhiteSpace` | `boolean` | No | — | |
|
|
221
|
-
| `radius` | `"
|
|
221
|
+
| `radius` | `"circle" | "small" | "large" | "base" | "larger"` | No | — | |
|
|
222
222
|
| `tabIndex` | `number` | No | — | [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex) |
|
|
223
223
|
| `width` | `BoxDimension` | No | `auto` | |
|
|
@@ -935,13 +935,13 @@ export const styles = StyleSheet.create({
|
|
|
935
935
|
| Prop | Type | Required | Default | Description |
|
|
936
936
|
|------|------|----------|---------|-------------|
|
|
937
937
|
| `align` | `"center" | "end" | "start"` | No | `"start"` | Sets the alignment to start, center, or end. In LTR scripts this equates to left, center, or right. |
|
|
938
|
-
| `element` | `"h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p" | "b" | "em" | "dd" | "dt" | "strong"
|
|
938
|
+
| `element` | `"span" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p" | "b" | "em" | "dd" | "dt" | "strong"` | No | `span` | |
|
|
939
939
|
| `emphasisType` | `"highlight" | "italic"` | No | — | |
|
|
940
940
|
| `fontFamily` | `"base" | "display"` | No | `base` | |
|
|
941
941
|
| `fontWeight` | `"black" | "bold" | "extraBold" | "medium" | "regular" | "semiBold"` | No | `semiBold` | Aside from changing the font weights, this also changes the font family. Source sans for `regular` and `bold`. Poppin... |
|
|
942
942
|
| `id` | `string` | No | — | |
|
|
943
943
|
| `numberOfLines` | `number` | No | — | |
|
|
944
|
-
| `size` | `"small" | "
|
|
944
|
+
| `size` | `"small" | "large" | "base" | "smaller" | "larger" | "largest" | "extravagant" | "jumbo"` | No | — | |
|
|
945
945
|
| `textCase` | `"none" | "capitalize" | "lowercase" | "uppercase"` | No | — | |
|
|
946
946
|
| `underline` | `UnderlineStyle | "solid color-indigo" | "solid color-indigo--light" | "solid color-indigo--lighter" | "solid color-indigo--lightest" | "solid color-indigo--dark" | ... 646 more ... | "dashed color-client--onSurface"` | No | — | The style (and optionally a color) of underline the text is decorated with. All semantic color tokens (other than the... |
|
|
947
947
|
| `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... |
|
|
@@ -952,7 +952,7 @@ export const styles = StyleSheet.create({
|
|
|
952
952
|
| Prop | Type | Required | Default | Description |
|
|
953
953
|
|------|------|----------|---------|-------------|
|
|
954
954
|
| `name` | `IconNames` | Yes | — | The icon to show. |
|
|
955
|
-
| `size` | `"small" | "
|
|
955
|
+
| `size` | `"small" | "large" | "base"` | No | `base` | Changes the size to small or large. |
|
|
956
956
|
| `testID` | `string` | No | — | Used to locate this view in end-to-end tests |
|
|
957
957
|
| `UNSAFE_className` | `{ svg?: string; path?: string; }` | No | — | **Use at your own risk:** Custom classnames for specific elements. This should only be used as a **last resort**. Usi... |
|
|
958
958
|
| `UNSAFE_style` | `{ svg?: CSSProperties; path?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
package/dist/docs/Card/Card.md
CHANGED
|
@@ -262,10 +262,10 @@ desired markup and have no need for either UNSAFE.
|
|
|
262
262
|
|
|
263
263
|
| Prop | Type | Required | Default | Description |
|
|
264
264
|
|------|------|----------|---------|-------------|
|
|
265
|
-
| `accent` | `"blue" | "
|
|
265
|
+
| `accent` | `"indigo" | "teal" | "blue" | "green" | "lime" | "yellowGreen" | "yellow" | "red" | "grey" | "white" | "greyBlue" | "lightBlue" | "purple" | "pink" | "orange" | "brown" | "navy" | ... 68 more ... | "yellowLightest"` | No | — | The `accent`, if provided, will effect the color accent at the top of the card. |
|
|
266
266
|
| `elevation` | `elevationProp` | No | — | |
|
|
267
267
|
| `external` | `boolean` | No | — | Makes the URL open in new tab on click. |
|
|
268
|
-
| `header` | `string |
|
|
268
|
+
| `header` | `string | ReactElement<unknown, string | JSXElementConstructor<any>> | HeaderActionProps` | No | — | The header props of the card. |
|
|
269
269
|
| `onClick` | `(event: MouseEvent<HTMLAnchorElement | HTMLDivElement, MouseEvent>) => void` | No | — | Event handler that gets called when the card is clicked. |
|
|
270
270
|
| `title` | `string` | No | — | @deprecated Use header instead. |
|
|
271
271
|
| `UNSAFE_className` | `{ container?: string; header?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
@@ -59,7 +59,7 @@ able to keep track the state of the child Checkboxes. See
|
|
|
59
59
|
| Prop | Type | Required | Default | Description |
|
|
60
60
|
|------|------|----------|---------|-------------|
|
|
61
61
|
| `aria-activedescendant` | `string` | No | — | ID of the currently active descendant element. Used for composite widgets like combobox or listbox. @see {@link https... |
|
|
62
|
-
| `aria-autocomplete` | `"
|
|
62
|
+
| `aria-autocomplete` | `"list" | "none" | "inline" | "both"` | No | — | Indicates the type of autocomplete interaction. @see {@link https://www.w3.org/TR/wai-aria-1.2/#aria-autocomplete} |
|
|
63
63
|
| `aria-controls` | `string` | No | — | Indicates the element that controls the current element. @see {@link https://www.w3.org/TR/wai-aria-1.2/#aria-controls} |
|
|
64
64
|
| `aria-describedby` | `string` | No | — | Identifies the element (or elements) that describes the object. @see {@link https://www.w3.org/TR/wai-aria-1.2/#aria-... |
|
|
65
65
|
| `aria-details` | `string` | No | — | Identifies the element (or elements) that provide a detailed, extended description. @see {@link https://www.w3.org/TR... |
|
|
@@ -84,5 +84,5 @@ able to keep track the state of the child Checkboxes. See
|
|
|
84
84
|
| `onMouseUp` | `(event: MouseEvent<HTMLInputElement, MouseEvent>) => void` | No | — | Mouse up event handler. |
|
|
85
85
|
| `onPointerDown` | `(event: PointerEvent<HTMLInputElement>) => void` | No | — | Pointer down event handler. |
|
|
86
86
|
| `onPointerUp` | `(event: PointerEvent<HTMLInputElement>) => void` | No | — | Pointer up event handler. |
|
|
87
|
-
| `ref` | `Ref<
|
|
87
|
+
| `ref` | `Ref<InputTextRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
88
88
|
| `value` | `string` | No | — | Value of the checkbox. |
|
package/dist/docs/Chip/Chip.md
CHANGED
|
@@ -369,7 +369,7 @@ those more complex selection flows.
|
|
|
369
369
|
| `onClick` | `((ev: MouseEvent<HTMLButtonElement | HTMLDivElement, MouseEvent>) => void) & MouseEventHandler<ChipElement>` | No | — | Chip click callback using a standard event-first signature. |
|
|
370
370
|
| `onClickValue` | `(value: string | number, ev: MouseEvent<HTMLButtonElement | HTMLDivElement, MouseEvent>) => void` | No | — | Value-first click callback retained as an upgrade path for existing consumers. @deprecated Prefer `onClick` with a cl... |
|
|
371
371
|
| `onKeyDown` | `((ev: KeyboardEvent<HTMLButtonElement | HTMLDivElement>) => void) & KeyboardEventHandler<ChipElement>` | No | — | Callback. Called when you keydown on Chip. Ships the event, so you can get the key pushed. |
|
|
372
|
-
| `ref` | `Ref<
|
|
372
|
+
| `ref` | `Ref<InputTextRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
373
373
|
| `role` | `string` | No | `button` | The accessible role the Chip is fulfilling. Defaults to 'button' |
|
|
374
374
|
| `tabIndex` | `number` | No | `0` | Used for accessibility purpopses, specifically using the tab key as navigation. |
|
|
375
375
|
| `testID` | `string` | No | — | The testing id for the chip if necessary. |
|
package/dist/docs/Chips/Chips.md
CHANGED
|
@@ -172,7 +172,7 @@ is a Base Chip.
|
|
|
172
172
|
| `activator` | `ReactElement<unknown, string | JSXElementConstructor<any>>` | No | — | Use a custom activator to trigger the Chip option selector |
|
|
173
173
|
| `autoSelectOnClickOutside` | `boolean` | No | `false` | If true, automatically selects an option based on the current search value when the input loses focus. The automatic ... |
|
|
174
174
|
| `isLoadingMore` | `boolean` | No | — | Adds a loading indicator |
|
|
175
|
-
| `onClick` | `(event: MouseEvent<
|
|
175
|
+
| `onClick` | `(event: MouseEvent<HTMLInputElement | HTMLButtonElement | HTMLDivElement, MouseEvent>, clickedChipValue?: string) => void` | No | — | Callback when a specific chip is clicked @param event @param clickedChipValue - The value of the chip that was clicked |
|
|
176
176
|
| `onCustomAdd` | `(value: string) => void` | No | — | Callback when the user selects the custom option instead of the available chips. If not implemented, it won't allow ... |
|
|
177
177
|
| `onLoadMore` | `(searchValue: string) => void` | No | — | Callback when the user scrolls at the end of the chip option list. Use this to load more options from the database. @... |
|
|
178
178
|
| `onlyShowMenuOnSearch` | `boolean` | No | `false` | Control whether the menu only appears once the user types. |
|
|
@@ -219,7 +219,7 @@ equal spacing and consistent sizing.
|
|
|
219
219
|
|
|
220
220
|
| Prop | Type | Required | Default | Description |
|
|
221
221
|
|------|------|----------|---------|-------------|
|
|
222
|
-
| `align` | `"
|
|
222
|
+
| `align` | `"stretch" | "center" | "end" | "start"` | No | — | The vertical alignment of the cluster elements. |
|
|
223
223
|
| `ariaAttributes` | `AriaAttributes` | No | — | Standard HTML aria attributes. Accepts all standard HTML aria attributes. |
|
|
224
224
|
| `as` | `CommonAllowedElements` | No | `div` | The HTML tag to render the cluster as. |
|
|
225
225
|
| `autoWidth` | `boolean` | No | `false` | Enabling this prevents the cluster from taking 100% of the width of the parent and instead flows with the content. |
|
|
@@ -228,7 +228,7 @@ equal spacing and consistent sizing.
|
|
|
228
228
|
| `dataAttributes` | `{ [key: `data-${string}`]: string; }` | No | — | Standard HTML data attributes. Accepts anything in a {{"data-key":"value"}} format. |
|
|
229
229
|
| `gap` | `GapSpacing` | No | — | The amount of space between the cluster elements. Semantic tokens are available. |
|
|
230
230
|
| `id` | `string` | No | — | Standard HTML id attribute. |
|
|
231
|
-
| `justify` | `"
|
|
231
|
+
| `justify` | `"space-around" | "space-between" | "center" | "end" | "start"` | No | — | The horizontal justification of the cluster elements. |
|
|
232
232
|
| `role` | `AriaRole` | No | — | Standard HTML role attribute. |
|
|
233
233
|
| `UNSAFE_className` | `{ container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
234
234
|
| `UNSAFE_style` | `{ container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
@@ -277,6 +277,6 @@ window.HTMLElement.prototype.scrollIntoView = scrollIntoViewMock;
|
|
|
277
277
|
|------|------|----------|---------|-------------|
|
|
278
278
|
| `id` | `string | number` | Yes | — | A unique identifier for the option. |
|
|
279
279
|
| `label` | `string` | Yes | — | The value to be visually displayed in the Combobox options list. |
|
|
280
|
-
| `customRender` | `(option: Pick<ComboboxOptionProps, "
|
|
280
|
+
| `customRender` | `(option: Pick<ComboboxOptionProps, "prefix" | "label" | "id"> & { isSelected: boolean; defaultContent: ReactElement<unknown, string | JSXElementConstructor<any>>; }) => ReactNode` | No | — | Advanced: A custom render prop to completely control how this option is rendered. The function receives the option's ... |
|
|
281
281
|
| `onClick` | `(option: ComboboxOptionProps) => void` | No | — | Callback function invoked when the option is clicked. |
|
|
282
282
|
| `prefix` | `ReactNode` | No | — | An optional component to be displayed before the label. |
|
|
@@ -119,7 +119,7 @@ language should be direct and honest about the impact without being alarming.
|
|
|
119
119
|
| `onConfirm` | `() => void` | No | — | Callback for when the confirm button is pressed. |
|
|
120
120
|
| `onRequestClose` | `() => void` | No | — | Callback for whenever a user's action should close the modal. |
|
|
121
121
|
| `open` | `boolean` | No | `false` | Controls if the modal is open or not. |
|
|
122
|
-
| `ref` | `Ref<
|
|
122
|
+
| `ref` | `Ref<InputTextRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
123
123
|
| `size` | `"small" | "large"` | No | — | Size of the modal (small, large), |
|
|
124
124
|
| `title` | `string` | No | — | Title for the modal. |
|
|
125
125
|
| `variation` | `"work" | "destructive"` | No | `work` | Type (Work or destructive) for confirm button. |
|
|
@@ -60,5 +60,5 @@ UNSAFE_style: {
|
|
|
60
60
|
|
|
61
61
|
| Prop | Type | Required | Default | Description |
|
|
62
62
|
|------|------|----------|---------|-------------|
|
|
63
|
-
| `spacing` | `"
|
|
64
|
-
| `type` | `"
|
|
63
|
+
| `spacing` | `"small" | "large" | "base" | "minuscule" | "smallest" | "smaller" | "slim" | "larger" | "largest" | "extravagant"` | No | `base` | The amount of vertical spacing between the children |
|
|
64
|
+
| `type` | `"div" | "section" | "article" | "aside" | "main" | "header" | "footer"` | No | `div` | Change the wrapping element to be one of the available semantic tags. |
|
|
@@ -125,8 +125,8 @@ export function ContentBlockWithGuttersExample(
|
|
|
125
125
|
| `dataAttributes` | `{ [key: `data-${string}`]: string; }` | No | — | Standard HTML data attributes. Accepts anything in a {{"data-key":"value"}} format. |
|
|
126
126
|
| `gutters` | `GapSpacing` | No | — | The amount of space between the content and the edges of the container. |
|
|
127
127
|
| `id` | `string` | No | — | Standard HTML id attribute. |
|
|
128
|
-
| `justify` | `"
|
|
129
|
-
| `maxWidth` | `number | "xs" | "sm" | "md" | "lg" | "xl"
|
|
128
|
+
| `justify` | `"center" | "left" | "right"` | No | `left` | The justification of the content. |
|
|
129
|
+
| `maxWidth` | `number | (string & {}) | "xs" | "sm" | "md" | "lg" | "xl"` | No | `Breakpoints.smaller` | The maximum width of the centered content. |
|
|
130
130
|
| `role` | `AriaRole` | No | — | Standard HTML role attribute. |
|
|
131
131
|
| `UNSAFE_className` | `{ container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
132
132
|
| `UNSAFE_style` | `{ container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
@@ -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` | `"initial" | "
|
|
523
|
+
| `loadingState` | `"initial" | "none" | "filtering" | "loadingMore"` | 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. |
|
|
@@ -534,7 +534,7 @@ objects that will define the sorting options for the column.
|
|
|
534
534
|
| Prop | Type | Required | Default | Description |
|
|
535
535
|
|------|------|----------|---------|-------------|
|
|
536
536
|
| `message` | `string` | Yes | — | The message that shows when the DataList is empty. |
|
|
537
|
-
| `action` | `ReactElement<{
|
|
537
|
+
| `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... |
|
|
538
538
|
| `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... |
|
|
539
539
|
| `type` | `"filtered" | "empty"` | No | — | Determine the type of empty state to show. By default, it will show the "empty" state when there is no data. If you ... |
|
|
540
540
|
|
|
@@ -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` | `"large" | "base" | "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... |
|
|
@@ -72,4 +72,4 @@ export function EmphasisHighlightExample() {
|
|
|
72
72
|
|
|
73
73
|
| Prop | Type | Required | Default | Description |
|
|
74
74
|
|------|------|----------|---------|-------------|
|
|
75
|
-
| `variation` | `"bold" | "
|
|
75
|
+
| `variation` | `"bold" | "highlight" | "italic"` | Yes | — | |
|
package/dist/docs/Flex/Flex.md
CHANGED
|
@@ -33,6 +33,6 @@ one-directional layout.
|
|
|
33
33
|
| Prop | Type | Required | Default | Description |
|
|
34
34
|
|------|------|----------|---------|-------------|
|
|
35
35
|
| `template` | `ColumnKeys[]` | Yes | — | Determine how the children gets laid out **Supported keys** - `"grow"` - Grows to the space available. If all childr... |
|
|
36
|
-
| `align` | `"
|
|
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` | `"small" | "large" | "base" | "minuscule" | "smallest" | "smaller" | "slim" | "larger" | "largest" | "extravagant" | "none"` | 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<InputTextRef>` | No | — | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (... |
|
|
@@ -85,7 +85,7 @@ export function SpecialInput(props) {
|
|
|
85
85
|
| `size` | `"small" | "large"` | 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` | `"while-editing" | "always"` | 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
91
|
| `value` | `string | number | Date` | No | — | Set the component to the given value. |
|
|
@@ -32,7 +32,7 @@ image, while expanded is used to display a file alongside its metadata.
|
|
|
32
32
|
|------|------|----------|---------|-------------|
|
|
33
33
|
| `file` | `FileUpload` | Yes | — | File upload details object. (See FileUpload type.) |
|
|
34
34
|
| `display` | `"expanded" | "compact"` | No | `expanded` | To display as either a file row or thumbnail |
|
|
35
|
-
| `displaySize` | `"
|
|
35
|
+
| `displaySize` | `"large" | "base"` | 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
|
|
|
@@ -65,7 +65,7 @@ image, while expanded is used to display a file alongside its metadata.
|
|
|
65
65
|
| `className` | `string` | No | — | |
|
|
66
66
|
| `onClick` | `MouseEventHandler<HTMLButtonElement | HTMLDivElement>` | No | — | |
|
|
67
67
|
| `tabIndex` | `number` | No | — | |
|
|
68
|
-
| `type` | `"
|
|
68
|
+
| `type` | `"submit" | "button" | "reset"` | No | — | |
|
|
69
69
|
|
|
70
70
|
#### FormatFile.Expanded
|
|
71
71
|
|
|
@@ -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` | `"large" | "base"` | No | `base` | The size of the files and their spacing in the gallery |
|
|
@@ -141,7 +141,7 @@ 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` | `"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... |
|
|
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
|
|
|
@@ -149,7 +149,7 @@ export function GlimmerSemanticBlocksExample() {
|
|
|
149
149
|
|
|
150
150
|
| Prop | Type | Required | Default | Description |
|
|
151
151
|
|------|------|----------|---------|-------------|
|
|
152
|
-
| `level` | `1 | 2 |
|
|
152
|
+
| `level` | `1 | 2 | 5 | 3 | 4` | No | `3` | Adjust the size of the `Glimmer.Header`. |
|
|
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. |
|
package/dist/docs/Grid/Grid.md
CHANGED
|
@@ -67,7 +67,7 @@ instead.
|
|
|
67
67
|
| Prop | Type | Required | Default | Description |
|
|
68
68
|
|------|------|----------|---------|-------------|
|
|
69
69
|
| `children` | `ReactNode` | Yes | — | `Grid.Cell` children |
|
|
70
|
-
| `alignItems` | `"
|
|
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
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... |
|
|
72
72
|
|
|
73
73
|
#### Grid.Cell
|
|
@@ -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` | `"h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p"
|
|
125
|
+
| `element` | `"span" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p"` | 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` | `"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... |
|
|
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
|
@@ -580,9 +580,9 @@ necessary.
|
|
|
580
580
|
| Prop | Type | Required | Default | Description |
|
|
581
581
|
|------|------|----------|---------|-------------|
|
|
582
582
|
| `name` | `IconNames` | Yes | — | The icon to show. |
|
|
583
|
-
| `color` | `"task" | "text" | "warning" | "icon" | "
|
|
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" | "
|
|
585
|
+
| `size` | `"small" | "large" | "base"` | 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" | "
|
|
144
|
+
| `size` | `"small" | "large" | "base" | "larger"` | 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` | `"list" | "none" | "inline" | "both"` | 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` | `"email" | "search" | "text" | "url" | "none" | "tel" | "numeric" | "decimal"` | 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,7 +146,7 @@ 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<InputTextRef>` | 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 |
|
|
@@ -359,7 +359,7 @@ function CustomUploadContent() {
|
|
|
359
359
|
| Prop | Type | Required | Default | Description |
|
|
360
360
|
|------|------|----------|---------|-------------|
|
|
361
361
|
| `getUploadParams` | `(file: File) => UploadParams | Promise<UploadParams>` | Yes | — | A callback that receives a file object and returns a `UploadParams` needed to upload the file. More info is availabl... |
|
|
362
|
-
| `allowedTypes` | `"all" | "images" | "basicImages"
|
|
362
|
+
| `allowedTypes` | `"all" | string[] | "images" | "basicImages"` | No | `all` | Allowed File types. @param "images" - only accepts all types of image @param "basicImages" - only accepts png, jpg ... |
|
|
363
363
|
| `allowMultiple` | `boolean` | No | `false` | Allow for multiple files to be selected for upload. |
|
|
364
364
|
| `buttonLabel` | `string` | No | `Automatic` | Label for the InputFile's button. |
|
|
365
365
|
| `children` | `ReactNode` | No | — | Children will be rendered instead of the default content |
|
|
@@ -373,7 +373,7 @@ function CustomUploadContent() {
|
|
|
373
373
|
| `onUploadStart` | `(file: FileUpload) => void` | No | — | Upload event handler. Triggered on upload start. |
|
|
374
374
|
| `size` | `"small" | "base"` | 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
|
-
| `variation` | `"
|
|
376
|
+
| `variation` | `"button" | "dropzone"` | No | `dropzone` | Display variation. |
|
|
377
377
|
|
|
378
378
|
#### InputFile.Button
|
|
379
379
|
|
|
@@ -404,22 +404,22 @@ function CustomUploadContent() {
|
|
|
404
404
|
|
|
405
405
|
| Prop | Type | Required | Default | Description |
|
|
406
406
|
|------|------|----------|---------|-------------|
|
|
407
|
-
| `align` | `"
|
|
407
|
+
| `align` | `"center" | "end" | "start"` | No | — | |
|
|
408
408
|
| `element` | `TextElement` | No | `"p"` | The HTML element to render the text as. |
|
|
409
|
-
| `maxLines` | `"small" | "
|
|
410
|
-
| `size` | `"small" | "
|
|
409
|
+
| `maxLines` | `"small" | "large" | "base" | "larger" | "single" | "unlimited"` | No | — | |
|
|
410
|
+
| `size` | `"small" | "large" | "base"` | 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` | `"info" | "disabled" | "success" | "error" | "default" | "subdued" | "warn"` | No | `subdued` | |
|
|
414
414
|
|
|
415
415
|
#### InputFile.HintText
|
|
416
416
|
|
|
417
417
|
| Prop | Type | Required | Default | Description |
|
|
418
418
|
|------|------|----------|---------|-------------|
|
|
419
|
-
| `align` | `"
|
|
419
|
+
| `align` | `"center" | "end" | "start"` | No | — | |
|
|
420
420
|
| `element` | `TextElement` | No | `"p"` | The HTML element to render the text as. |
|
|
421
|
-
| `maxLines` | `"small" | "
|
|
422
|
-
| `size` | `"small" | "
|
|
421
|
+
| `maxLines` | `"small" | "large" | "base" | "larger" | "single" | "unlimited"` | No | — | |
|
|
422
|
+
| `size` | `"small" | "large" | "base"` | 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` | `"info" | "disabled" | "success" | "error" | "default" | "subdued" | "warn"` | No | — | |
|
|
@@ -58,7 +58,7 @@ 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<InputTextRef>` | 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
63
|
| `size` | `"small" | "large"` | 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 |
|
package/dist/docs/Menu/Menu.md
CHANGED
|
@@ -308,4 +308,4 @@ through inline styles.
|
|
|
308
308
|
| `open` | `boolean` | No | — | |
|
|
309
309
|
| `style` | `CSSProperties` | No | — | |
|
|
310
310
|
| `UNSAFE_className` | `string | { menu?: string; header?: string; action?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
311
|
-
| `UNSAFE_style` | `{ menu?: CSSProperties; header?: CSSProperties; action?: CSSProperties; }
|
|
311
|
+
| `UNSAFE_style` | `CSSProperties | { menu?: CSSProperties; header?: CSSProperties; action?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
package/dist/docs/Modal/Modal.md
CHANGED
|
@@ -290,9 +290,9 @@ screen.getByRole("dialog", { name: /Billing Settings/i });
|
|
|
290
290
|
| `dismissible` | `boolean` | No | `true` | |
|
|
291
291
|
| `onRequestClose` | `() => void` | No | — | |
|
|
292
292
|
| `open` | `boolean` | No | `false` | |
|
|
293
|
-
| `primaryAction` | `{
|
|
294
|
-
| `secondaryAction` | `{
|
|
295
|
-
| `size` | `"
|
|
296
|
-
| `tertiaryAction` | `{
|
|
293
|
+
| `primaryAction` | `{ onClick?: never; external?: never; readonly name?: string; submit: never; readonly type?: ButtonType; readonly value?: string; readonly size?: ButtonSize; readonly ariaLabel?: string; ... 17 more ...; readonly children?: never; } | ... 34 more ... | { ...; }` | No | — | |
|
|
294
|
+
| `secondaryAction` | `{ onClick?: never; external?: never; readonly name?: string; submit: never; readonly type?: ButtonType; readonly value?: string; readonly size?: ButtonSize; readonly ariaLabel?: string; ... 17 more ...; readonly children?: never; } | ... 34 more ... | { ...; }` | No | — | |
|
|
295
|
+
| `size` | `"small" | "large" | "fullScreen"` | No | — | |
|
|
296
|
+
| `tertiaryAction` | `{ onClick?: never; external?: never; readonly name?: string; submit: never; readonly type?: ButtonType; readonly value?: string; readonly size?: ButtonSize; readonly ariaLabel?: string; ... 17 more ...; readonly children?: never; } | ... 34 more ... | { ...; }` | No | — | |
|
|
297
297
|
| `title` | `string` | No | `false` | |
|
|
298
298
|
| `version` | `1` | No | — | |
|
|
@@ -261,7 +261,7 @@ If you're using Popover with its composable subcomponents, you'll need to pass
|
|
|
261
261
|
| `children` | `ReactNode` | Yes | — | Popover content. |
|
|
262
262
|
| `open` | `boolean` | Yes | — | Control Popover visibility. |
|
|
263
263
|
| `onRequestClose` | `() => void` | No | — | Callback executed when the user wants to close/dismiss the Popover |
|
|
264
|
-
| `preferredPlacement` | `"
|
|
264
|
+
| `preferredPlacement` | `"auto" | "left" | "right" | "top" | "bottom"` | No | `auto` | Describes the preferred placement of the Popover. |
|
|
265
265
|
| `UNSAFE_className` | `{ container?: string; dismissButtonContainer?: string; arrow?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
266
266
|
| `UNSAFE_style` | `{ container?: CSSProperties; dismissButtonContainer?: CSSProperties; arrow?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
267
267
|
|
|
@@ -271,7 +271,7 @@ If you're using Popover with its composable subcomponents, you'll need to pass
|
|
|
271
271
|
|------|------|----------|---------|-------------|
|
|
272
272
|
| `attachTo` | `Element | RefObject<Element>` | Yes | — | Element the Popover will attach to and point at. A `useRef` must be attached to an html element and passed as an atta... |
|
|
273
273
|
| `open` | `boolean` | Yes | — | Control Popover visibility. |
|
|
274
|
-
| `preferredPlacement` | `"
|
|
274
|
+
| `preferredPlacement` | `"auto" | "left" | "right" | "top" | "bottom"` | No | `auto` | Describes the preferred placement of the Popover. |
|
|
275
275
|
| `UNSAFE_className` | `{ container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
276
276
|
| `UNSAFE_style` | `{ container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
277
277
|
|
|
@@ -30,7 +30,7 @@ An example where you might be better served using a Spinner:
|
|
|
30
30
|
|------|------|----------|---------|-------------|
|
|
31
31
|
| `currentStep` | `number` | Yes | — | The current step that the progress bar is on. |
|
|
32
32
|
| `totalSteps` | `number` | Yes | — | The total steps to use. For percentages you can set this to 100. |
|
|
33
|
-
| `size` | `"
|
|
33
|
+
| `size` | `"small" | "base" | "smaller"` | No | `base` | Set the size of the progress bar |
|
|
34
34
|
| `UNSAFE_className` | `string` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
35
35
|
| `UNSAFE_style` | `CSSProperties` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
36
36
|
| `variation` | `"progress" | "stepped"` | No | `progress` | Set the variation of the progress bar |
|
|
@@ -26,5 +26,5 @@ do not contain text, an `aria-label` should be provided.
|
|
|
26
26
|
| `ariaLabel` | `string` | Yes | — | Defines the aria label that describes the radio group. |
|
|
27
27
|
| `onChange` | `(newValue: string | number) => void` | Yes | — | Change handler for the RadioGroup. @param newValue |
|
|
28
28
|
| `value` | `string | number` | Yes | — | Defines the default value that will be pre-selected in the radio group. |
|
|
29
|
-
| `direction` | `"
|
|
29
|
+
| `direction` | `"horizontal" | "vertical"` | No | `vertical` | Layout direction for the options. |
|
|
30
30
|
| `name` | `string` | No | `useId()` | The name of the radio group, that links the radio options back up to the group. |
|
|
@@ -175,7 +175,7 @@ browser handles this behaviour automatically.
|
|
|
175
175
|
| `name` | `string` | No | `useId()` | A unique name for the SegmentedControl, that links the group of options together. Can be a string or, if not set, wil... |
|
|
176
176
|
| `onSelectValue` | `(value: T) => void` | No | — | A callback function that is called whenever the selected option changes. Use this prop with `selectedValue` for a con... |
|
|
177
177
|
| `selectedValue` | `T` | No | — | The currently selected option. Use this prop with `onSelectValue` for a controlled component. |
|
|
178
|
-
| `size` | `"small" | "
|
|
178
|
+
| `size` | `"small" | "large" | "base"` | No | `base` | Adjusts the size of the SegmentedControl. The default size is "base". |
|
|
179
179
|
|
|
180
180
|
#### SegmentedControl.Option
|
|
181
181
|
|
|
@@ -198,7 +198,7 @@ dropdown content is stylable; the closed value alignment is not.
|
|
|
198
198
|
|------|------|----------|---------|-------------|
|
|
199
199
|
| `align` | `"center" | "right"` | No | — | Determines the alignment of the text inside the input. |
|
|
200
200
|
| `aria-activedescendant` | `string` | No | — | ID of the currently active descendant element. Used for composite widgets like combobox or listbox. @see {@link https... |
|
|
201
|
-
| `aria-autocomplete` | `"
|
|
201
|
+
| `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} |
|
|
202
202
|
| `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} |
|
|
203
203
|
| `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-... |
|
|
204
204
|
| `aria-details` | `string` | No | — | Identifies the element (or elements) that provide a detailed, extended description. @see {@link https://www.w3.org/TR... |
|
|
@@ -214,7 +214,7 @@ dropdown content is stylable; the closed value alignment is not.
|
|
|
214
214
|
| `error` | `string` | No | — | Error message to display. This also highlights the field red. |
|
|
215
215
|
| `id` | `string` | No | — | The unique identifier for the input element. |
|
|
216
216
|
| `inline` | `boolean` | No | — | Adjusts the form field to go inline with content. |
|
|
217
|
-
| `inputMode` | `"
|
|
217
|
+
| `inputMode` | `"email" | "search" | "text" | "url" | "none" | "tel" | "numeric" | "decimal"` | No | — | Input mode hint for virtual keyboards. |
|
|
218
218
|
| `inputRef` | `Ref<HTMLSelectElement>` | No | — | |
|
|
219
219
|
| `invalid` | `boolean` | No | — | Highlights the field red to indicate an error. |
|
|
220
220
|
| `loading` | `boolean` | No | — | Show a spinner to indicate loading. |
|
package/dist/docs/Stack/Stack.md
CHANGED
|
@@ -181,7 +181,7 @@ and screen reader compatibility.
|
|
|
181
181
|
|
|
182
182
|
| Prop | Type | Required | Default | Description |
|
|
183
183
|
|------|------|----------|---------|-------------|
|
|
184
|
-
| `align` | `"
|
|
184
|
+
| `align` | `"center" | "end" | "start"` | No | — | The alignment of the stack. |
|
|
185
185
|
| `ariaAttributes` | `AriaAttributes` | No | — | Standard HTML aria attributes. Accepts all standard HTML aria attributes. |
|
|
186
186
|
| `as` | `CommonAllowedElements` | No | `div` | The HTML tag to render the container as. Defaults to `div`. |
|
|
187
187
|
| `autoWidth` | `boolean` | No | `false` | Whether to allow the stack to take the width of the content. Defaults to 100% |
|
|
@@ -190,6 +190,6 @@ and screen reader compatibility.
|
|
|
190
190
|
| `id` | `string` | No | — | Standard HTML id attribute. |
|
|
191
191
|
| `recursive` | `boolean` | No | — | Whether to recursively apply the stack spacing to all the children, not just the top-level. |
|
|
192
192
|
| `role` | `AriaRole` | No | — | Standard HTML role attribute. |
|
|
193
|
-
| `splitAfter` | `1 | 2 | 3 | 4 |
|
|
193
|
+
| `splitAfter` | `1 | 2 | 5 | 3 | 4 | 6 | 11 | 7 | 8 | 9 | 10 | 12 | 13 | 14 | 15` | No | — | Setting this will push the stack down to the bottom of the parent container, after the number of children provided (1... |
|
|
194
194
|
| `UNSAFE_className` | `{ container?: string; }` | No | — | **Use at your own risk:** Custom class names for specific elements. This should only be used as a **last resort**. Us... |
|
|
195
195
|
| `UNSAFE_style` | `{ container?: CSSProperties; }` | No | — | **Use at your own risk:** Custom style for specific elements. This should only be used as a **last resort**. Using th... |
|
|
@@ -115,5 +115,5 @@ the label should wrap.
|
|
|
115
115
|
| Prop | Type | Required | Default | Description |
|
|
116
116
|
|------|------|----------|---------|-------------|
|
|
117
117
|
| `label` | `string` | Yes | — | Text to display |
|
|
118
|
-
| `alignment` | `"
|
|
118
|
+
| `alignment` | `"end" | "start"` | No | `start` | Alignment of label |
|
|
119
119
|
| `status` | `StatusIndicatorType` | No | `inactive` | Status color of the indicator beside text |
|
package/dist/docs/Text/Text.md
CHANGED
|
@@ -349,10 +349,10 @@ under the [Typography](../Typography/Typography.md) documentation.
|
|
|
349
349
|
|
|
350
350
|
| Prop | Type | Required | Default | Description |
|
|
351
351
|
|------|------|----------|---------|-------------|
|
|
352
|
-
| `align` | `"
|
|
352
|
+
| `align` | `"center" | "end" | "start"` | No | `start` | |
|
|
353
353
|
| `element` | `TextElement` | No | `p` | The HTML element to render the text as. |
|
|
354
|
-
| `maxLines` | `"
|
|
355
|
-
| `size` | `"small" | "
|
|
354
|
+
| `maxLines` | `"small" | "large" | "base" | "larger" | "single" | "unlimited"` | No | `unlimited` | |
|
|
355
|
+
| `size` | `"small" | "large" | "base"` | No | `base` | |
|
|
356
356
|
| `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... |
|
|
357
357
|
| `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... |
|
|
358
|
-
| `variation` | `"
|
|
358
|
+
| `variation` | `"info" | "disabled" | "success" | "error" | "default" | "subdued" | "warn"` | No | `default` | |
|
package/dist/docs/Tiles/Tiles.md
CHANGED
|
@@ -176,7 +176,7 @@ The Tiles component:
|
|
|
176
176
|
|
|
177
177
|
| Prop | Type | Required | Default | Description |
|
|
178
178
|
|------|------|----------|---------|-------------|
|
|
179
|
-
| `align` | `"
|
|
179
|
+
| `align` | `"center" | "end" | "start"` | No | `start` | The vertical alignment of the tiles within the container. |
|
|
180
180
|
| `ariaAttributes` | `AriaAttributes` | No | — | Standard HTML aria attributes. Accepts all standard HTML aria attributes. |
|
|
181
181
|
| `as` | `CommonAllowedElements` | No | `div` | The HTML tag to render the container as. Defaults to `div`. |
|
|
182
182
|
| `autoWidth` | `boolean` | No | `false` | Whether to allow the tiles to take the width of the content. Defaults to 100% |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jobber/components",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.10.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.cjs",
|
|
@@ -583,5 +583,5 @@
|
|
|
583
583
|
"> 1%",
|
|
584
584
|
"IE 10"
|
|
585
585
|
],
|
|
586
|
-
"gitHead": "
|
|
586
|
+
"gitHead": "348d1293520051687a9b2d178cf4c5757136e9bf"
|
|
587
587
|
}
|