@viraui/react 2026.6.5 → 2026.7.0-next.1
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/catalog.json +24 -0
- package/dist/components/accordion/accordion-item.d.ts +10 -10
- package/dist/components/accordion/accordion.d.ts +2 -2
- package/dist/components/annotate/annotate.d.ts +15 -15
- package/dist/components/autocomplete/autocomplete-item.d.ts +3 -3
- package/dist/components/autocomplete/autocomplete.d.ts +12 -12
- package/dist/components/autocomplete/autocomplete.js +1 -1
- package/dist/components/avatar/avatar.d.ts +6 -6
- package/dist/components/avatar-group/avatar-group.d.ts +6 -6
- package/dist/components/badge/badge.d.ts +5 -5
- package/dist/components/basic-input/basic-input.d.ts +3 -2
- package/dist/components/basic-input/basic-input.js +7 -0
- package/dist/components/basic-input/input-control-group.d.ts +2 -2
- package/dist/components/beam/beam-pulse-driver.d.ts +1 -0
- package/dist/components/beam/beam-pulse-driver.js +2 -2
- package/dist/components/beam/beam.css +1 -1
- package/dist/components/beam/beam.d.ts +17 -14
- package/dist/components/beam/beam.js +31 -26
- package/dist/components/bleed/bleed.d.ts +3 -3
- package/dist/components/button/button-link.d.ts +1 -1
- package/dist/components/button/button.d.ts +1 -1
- package/dist/components/checkbox/checkbox-group.d.ts +1 -1
- package/dist/components/checkbox/checkbox.d.ts +7 -7
- package/dist/components/chip/chip.d.ts +6 -6
- package/dist/components/clamp-text/clamp-text.d.ts +5 -5
- package/dist/components/dialog/dialog-close.d.ts +1 -1
- package/dist/components/dialog/dialog-indent-background.d.ts +1 -1
- package/dist/components/dialog/dialog-indent.d.ts +1 -1
- package/dist/components/dialog/dialog-sheet.d.ts +10 -10
- package/dist/components/dialog/dialog-sheet.js +1 -1
- package/dist/components/dialog/dialog-trigger.d.ts +1 -1
- package/dist/components/dialog/dialog.d.ts +1 -1
- package/dist/components/disclosure/disclosure-panel.d.ts +12 -0
- package/dist/components/disclosure/disclosure-panel.js +13 -0
- package/dist/components/disclosure/disclosure-trigger.d.ts +46 -0
- package/dist/components/disclosure/disclosure-trigger.js +82 -0
- package/dist/components/disclosure/disclosure.css +1 -0
- package/dist/components/disclosure/disclosure.d.ts +25 -0
- package/dist/components/disclosure/disclosure.js +30 -0
- package/dist/components/disclosure/disclosure.module.js +15 -0
- package/dist/components/disclosure/index.d.ts +4 -0
- package/dist/components/elevator/elevator.d.ts +7 -7
- package/dist/components/fieldset/fieldset.d.ts +4 -4
- package/dist/components/fit-text/fit-text.d.ts +2 -2
- package/dist/components/glow/glow.d.ts +12 -12
- package/dist/components/grid/grid-item.d.ts +8 -8
- package/dist/components/grid/grid.d.ts +12 -12
- package/dist/components/icon-button/icon-button-link.d.ts +2 -2
- package/dist/components/icon-button/icon-button.d.ts +2 -2
- package/dist/components/index.d.ts +4 -0
- package/dist/components/linear-progress/linear-progress.d.ts +4 -4
- package/dist/components/masonry/masonry-item.d.ts +3 -3
- package/dist/components/masonry/masonry.d.ts +4 -4
- package/dist/components/menu/menu-checkbox-item.d.ts +4 -4
- package/dist/components/menu/menu-item.d.ts +4 -4
- package/dist/components/menu/menu-link-item.d.ts +4 -4
- package/dist/components/menu/menu-popup.d.ts +2 -2
- package/dist/components/menu/menu-popup.js +1 -1
- package/dist/components/menu/menu-radio-group.d.ts +2 -2
- package/dist/components/menu/menu-radio-item.d.ts +4 -4
- package/dist/components/menu/menu-separator.d.ts +1 -1
- package/dist/components/menu/menu-submenu-trigger.d.ts +3 -3
- package/dist/components/menu/menu.d.ts +3 -3
- package/dist/components/meter/meter.css +1 -1
- package/dist/components/meter/meter.d.ts +15 -5
- package/dist/components/meter/meter.js +2 -1
- package/dist/components/number-field/index.d.ts +2 -0
- package/dist/components/number-field/number-field.css +1 -0
- package/dist/components/number-field/number-field.d.ts +78 -0
- package/dist/components/number-field/number-field.js +120 -0
- package/dist/components/number-field/number-field.module.js +21 -0
- package/dist/components/otp-field/index.d.ts +4 -0
- package/dist/components/otp-field/otp-field-input.d.ts +12 -0
- package/dist/components/otp-field/otp-field-input.js +29 -0
- package/dist/components/otp-field/otp-field-separator.d.ts +13 -0
- package/dist/components/otp-field/otp-field-separator.js +20 -0
- package/dist/components/otp-field/otp-field.css +1 -0
- package/dist/components/otp-field/otp-field.d.ts +48 -0
- package/dist/components/otp-field/otp-field.js +78 -0
- package/dist/components/otp-field/otp-field.module.js +23 -0
- package/dist/components/popover/popover-sheet.d.ts +6 -6
- package/dist/components/popover/popover.d.ts +5 -5
- package/dist/components/progressive-blur/progressive-blur.d.ts +5 -5
- package/dist/components/prose/index.d.ts +2 -0
- package/dist/components/prose/prose.css +1 -0
- package/dist/components/prose/prose.d.ts +40 -0
- package/dist/components/prose/prose.js +27 -0
- package/dist/components/prose/prose.module.js +5 -0
- package/dist/components/radio/radio-group.d.ts +1 -1
- package/dist/components/radio/radio.d.ts +6 -6
- package/dist/components/select/select-indicator-slot.d.ts +1 -1
- package/dist/components/select/select-option.d.ts +4 -4
- package/dist/components/select/select-separator.d.ts +1 -1
- package/dist/components/select/select.d.ts +10 -10
- package/dist/components/select/select.js +1 -1
- package/dist/components/separator/separator.d.ts +15 -8
- package/dist/components/separator/separator.js +2 -1
- package/dist/components/shimmer/shimmer.d.ts +6 -6
- package/dist/components/skeleton/skeleton-overlay.d.ts +5 -5
- package/dist/components/skeleton/skeleton.d.ts +9 -9
- package/dist/components/slider/slider.d.ts +7 -7
- package/dist/components/spinner/spinner.d.ts +3 -3
- package/dist/components/stack/stack.d.ts +17 -17
- package/dist/components/static-noise/static-noise.d.ts +5 -5
- package/dist/components/surface/surface.d.ts +12 -12
- package/dist/components/switch/switch.d.ts +7 -7
- package/dist/components/tabs/tabs-list.d.ts +1 -1
- package/dist/components/tabs/tabs-panel.d.ts +1 -1
- package/dist/components/tabs/tabs-tab.d.ts +3 -3
- package/dist/components/tabs/tabs.d.ts +2 -2
- package/dist/components/text/text.css +1 -1
- package/dist/components/text/text.d.ts +24 -23
- package/dist/components/text/text.js +4 -2
- package/dist/components/textarea/textarea.d.ts +6 -6
- package/dist/components/textfield/textfield.css +1 -1
- package/dist/components/textfield/textfield.d.ts +19 -11
- package/dist/components/textfield/textfield.js +43 -39
- package/dist/components/textfield/textfield.module.js +3 -1
- package/dist/components/title/title.css +1 -1
- package/dist/components/title/title.d.ts +22 -21
- package/dist/components/title/title.js +4 -2
- package/dist/components/toast/toast-action.d.ts +1 -1
- package/dist/components/toast/toast-banner.d.ts +7 -7
- package/dist/components/toast/toast-banner.js +1 -1
- package/dist/components/toast/toast-viewport.d.ts +2 -2
- package/dist/components/toggle-button/toggle-button.d.ts +6 -6
- package/dist/components/toggle-group/toggle-group.d.ts +1 -1
- package/dist/components/tooltip/tooltip-content.d.ts +2 -2
- package/dist/components/typewriter/typewriter.d.ts +10 -10
- package/dist/index.js +7 -3
- package/dist/specs/components/accordion/usage.xml +1 -0
- package/dist/specs/components/beam/a11y.xml +3 -3
- package/dist/specs/components/beam/props.xml +22 -1
- package/dist/specs/components/beam/usage.xml +1 -0
- package/dist/specs/components/disclosure/a11y.xml +9 -0
- package/dist/specs/components/disclosure/meta.xml +20 -0
- package/dist/specs/components/disclosure/patterns.xml +55 -0
- package/dist/specs/components/disclosure/props.xml +54 -0
- package/dist/specs/components/disclosure/usage.xml +11 -0
- package/dist/specs/components/meter/patterns.xml +12 -0
- package/dist/specs/components/meter/props.xml +7 -0
- package/dist/specs/components/meter/usage.xml +2 -0
- package/dist/specs/components/number-field/a11y.xml +10 -0
- package/dist/specs/components/number-field/meta.xml +21 -0
- package/dist/specs/components/number-field/patterns.xml +43 -0
- package/dist/specs/components/number-field/props.xml +35 -0
- package/dist/specs/components/number-field/usage.xml +12 -0
- package/dist/specs/components/otp-field/a11y.xml +10 -0
- package/dist/specs/components/otp-field/meta.xml +20 -0
- package/dist/specs/components/otp-field/patterns.xml +66 -0
- package/dist/specs/components/otp-field/props.xml +29 -0
- package/dist/specs/components/otp-field/usage.xml +13 -0
- package/dist/specs/components/prose/a11y.xml +7 -0
- package/dist/specs/components/prose/meta.xml +18 -0
- package/dist/specs/components/prose/patterns.xml +59 -0
- package/dist/specs/components/prose/props.xml +37 -0
- package/dist/specs/components/prose/usage.xml +12 -0
- package/dist/specs/components/separator/props.xml +3 -0
- package/dist/specs/components/separator/usage.xml +1 -0
- package/dist/specs/components/text/props.xml +2 -2
- package/dist/specs/components/text/usage.xml +1 -0
- package/dist/specs/components/textfield/meta.xml +1 -0
- package/dist/specs/components/textfield/props.xml +6 -1
- package/dist/specs/components/textfield/usage.xml +2 -1
- package/dist/specs/components/title/props.xml +2 -2
- package/dist/specs/components/title/usage.xml +1 -0
- package/dist/specs/index.xml +41 -1
- package/package.json +2 -2
|
@@ -5,7 +5,7 @@ export type SelectIndicatorSlotProps = {
|
|
|
5
5
|
* When true, renders as Base UI `ItemIndicator` with `keepMounted`.
|
|
6
6
|
* When false, renders an empty spacer with the same inline footprint.
|
|
7
7
|
*
|
|
8
|
-
* @
|
|
8
|
+
* @defaultValue false
|
|
9
9
|
*/
|
|
10
10
|
interactive?: boolean;
|
|
11
11
|
};
|
|
@@ -4,25 +4,25 @@ import type * as React from 'react';
|
|
|
4
4
|
/**
|
|
5
5
|
* Public Select.Option props.
|
|
6
6
|
*
|
|
7
|
-
* @
|
|
7
|
+
* @defaultValue Base UI pass-through props keep upstream defaults.
|
|
8
8
|
*/
|
|
9
9
|
export type SelectOptionProps = SelectItem.Props & {
|
|
10
10
|
/**
|
|
11
11
|
* Decorative leading node rendered before the option label.
|
|
12
12
|
*
|
|
13
|
-
* @
|
|
13
|
+
* @defaultValue No addon is rendered.
|
|
14
14
|
*/
|
|
15
15
|
addon?: React.ReactNode;
|
|
16
16
|
/**
|
|
17
17
|
* Vertical alignment of the addon relative to the option label row.
|
|
18
18
|
*
|
|
19
|
-
* @
|
|
19
|
+
* @defaultValue 'center'
|
|
20
20
|
*/
|
|
21
21
|
addonAlign?: StackProps['vAlign'];
|
|
22
22
|
/**
|
|
23
23
|
* Custom indicator node rendered when the option is selected.
|
|
24
24
|
*
|
|
25
|
-
* @
|
|
25
|
+
* @defaultValue Built-in Check chrome SVG at size 16
|
|
26
26
|
*/
|
|
27
27
|
indicator?: React.ReactNode;
|
|
28
28
|
};
|
|
@@ -3,7 +3,7 @@ import type * as React from 'react';
|
|
|
3
3
|
/**
|
|
4
4
|
* Public Select.Separator props.
|
|
5
5
|
*
|
|
6
|
-
* @
|
|
6
|
+
* @defaultValue `orientation` is `'horizontal'`.
|
|
7
7
|
*/
|
|
8
8
|
export type SelectSeparatorProps = React.ComponentProps<typeof PrimitiveSelect.Separator>;
|
|
9
9
|
export declare function SelectSeparator({ className, orientation, ...separatorProps }: SelectSeparatorProps): React.JSX.Element;
|
|
@@ -11,59 +11,59 @@ import type * as React from 'react';
|
|
|
11
11
|
* and change handlers, plus optional field copy rendered with the shared Vira
|
|
12
12
|
* field label/helper pattern.
|
|
13
13
|
*
|
|
14
|
-
* @
|
|
14
|
+
* @defaultValue Base UI pass-through props keep upstream defaults.
|
|
15
15
|
*/
|
|
16
16
|
export type SelectProps = SelectRoot.Props<string> & Omit<FieldRoot.Props, 'ref'> & {
|
|
17
17
|
/**
|
|
18
18
|
* Visible label rendered with shared internal `FieldLabel`.
|
|
19
19
|
*
|
|
20
|
-
* @
|
|
20
|
+
* @defaultValue No label is rendered.
|
|
21
21
|
*/
|
|
22
22
|
label?: React.ReactNode;
|
|
23
23
|
/**
|
|
24
24
|
* Helper copy rendered with `Field.Description` and `Text` while the field is valid.
|
|
25
25
|
*
|
|
26
|
-
* @
|
|
26
|
+
* @defaultValue No description is rendered.
|
|
27
27
|
*/
|
|
28
28
|
description?: React.ReactNode;
|
|
29
29
|
/**
|
|
30
30
|
* Error copy rendered with `Field.Error` and `Text` in the same slot as `description`.
|
|
31
31
|
* Replaces description while the field is invalid and dirty.
|
|
32
32
|
*
|
|
33
|
-
* @
|
|
33
|
+
* @defaultValue No static error copy is rendered.
|
|
34
34
|
*/
|
|
35
35
|
error?: React.ReactNode;
|
|
36
36
|
/**
|
|
37
37
|
* Placeholder text shown in the trigger when no value is selected.
|
|
38
38
|
*
|
|
39
|
-
* @
|
|
39
|
+
* @defaultValue No placeholder is rendered.
|
|
40
40
|
*/
|
|
41
41
|
placeholder?: React.ReactNode;
|
|
42
42
|
/**
|
|
43
43
|
* Trigger addon rendered inside `Select.Icon`.
|
|
44
44
|
* Pass any React node; use a named icon from `@viraui/icons/react` for content icons.
|
|
45
45
|
*
|
|
46
|
-
* @
|
|
46
|
+
* @defaultValue Built-in ChevronExpandY chrome SVG at size 16
|
|
47
47
|
*/
|
|
48
48
|
addon?: React.ReactNode;
|
|
49
49
|
/**
|
|
50
50
|
* Ref forwarded to the select trigger button.
|
|
51
51
|
*
|
|
52
|
-
* @
|
|
52
|
+
* @defaultValue No ref is attached.
|
|
53
53
|
*/
|
|
54
54
|
ref?: React.Ref<HTMLButtonElement>;
|
|
55
55
|
/**
|
|
56
56
|
* When `true`, aligns the list popup width with the trigger via Base UI `alignItemWithTrigger`.
|
|
57
57
|
* Prefer `false` when options use a leading `addon`.
|
|
58
58
|
*
|
|
59
|
-
* @
|
|
59
|
+
* @defaultValue true
|
|
60
60
|
*/
|
|
61
61
|
alignListWithTrigger?: boolean;
|
|
62
62
|
/**
|
|
63
63
|
* When `true`, open select locks page scroll and blocks outside pointer interaction
|
|
64
64
|
* (Base UI modal). Vira defaults to non-modal so the page stays scrollable.
|
|
65
65
|
*
|
|
66
|
-
* @
|
|
66
|
+
* @defaultValue false
|
|
67
67
|
*/
|
|
68
68
|
modal?: boolean;
|
|
69
69
|
/**
|
|
@@ -71,7 +71,7 @@ export type SelectProps = SelectRoot.Props<string> & Omit<FieldRoot.Props, 'ref'
|
|
|
71
71
|
* Omit for Base UI default (`document.body` from the module window —
|
|
72
72
|
* iframe hosts must pass the iframe document body explicitly).
|
|
73
73
|
*
|
|
74
|
-
* @
|
|
74
|
+
* @defaultValue Base UI FloatingPortal resolution
|
|
75
75
|
*/
|
|
76
76
|
container?: React.ComponentProps<typeof PrimitiveSelect.Portal>['container'];
|
|
77
77
|
};
|
|
@@ -6,8 +6,8 @@ import { Text } from "../text/text.js";
|
|
|
6
6
|
import { FieldHelperCopy } from "../basic-input/field-helper-copy.js";
|
|
7
7
|
import { FieldLabel } from "../basic-input/field-label.js";
|
|
8
8
|
import { Stack } from "../stack/stack.js";
|
|
9
|
-
import { Elevator } from "../elevator/elevator.js";
|
|
10
9
|
import { Surface } from "../surface/surface.js";
|
|
10
|
+
import { Elevator } from "../elevator/elevator.js";
|
|
11
11
|
import { IconButton } from "../icon-button/icon-button.js";
|
|
12
12
|
import select_module_default from "./select.module.js";
|
|
13
13
|
import { SelectGroup } from "./select-group.js";
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { useRender } from '@base-ui/react/use-render';
|
|
2
|
+
import { StackProps } from '../stack';
|
|
2
3
|
import { ThemeTypes } from '@viraui/foundation/vira/types';
|
|
3
4
|
import type * as React from 'react';
|
|
4
5
|
type SeparatorAxisPadding = ThemeTypes['space'] | [ThemeTypes['space'] | 0, ThemeTypes['space'] | 0];
|
|
@@ -10,49 +11,55 @@ type SeparatorSize = 's' | 'm' | 'l';
|
|
|
10
11
|
* plus Vira-owned orientation, line thickness, Stack padding, and Base UI `render` support for replacing the line root.
|
|
11
12
|
* `className`, `style`, and `ref` apply to the line root only.
|
|
12
13
|
*
|
|
13
|
-
* @
|
|
14
|
+
* @defaultValue Native pass-through props keep React defaults on the wrapper unless noted above.
|
|
14
15
|
*/
|
|
15
16
|
export type SeparatorProps = Omit<React.ComponentPropsWithoutRef<'div'>, 'children'> & {
|
|
16
17
|
/**
|
|
17
18
|
* Replaces the default `hr` line root using Base UI render semantics.
|
|
18
19
|
*
|
|
19
|
-
* @
|
|
20
|
+
* @defaultValue The separator renders an `hr` line root.
|
|
20
21
|
*/
|
|
21
22
|
render?: useRender.RenderProp;
|
|
22
23
|
/**
|
|
23
24
|
* Ref forwarded to the rendered line root element.
|
|
24
25
|
*
|
|
25
|
-
* @
|
|
26
|
+
* @defaultValue No ref is attached.
|
|
26
27
|
*/
|
|
27
28
|
ref?: React.Ref<HTMLElement>;
|
|
28
29
|
/**
|
|
29
30
|
* Sets the separator line direction.
|
|
30
31
|
*
|
|
31
|
-
* @
|
|
32
|
+
* @defaultValue 'horizontal'
|
|
32
33
|
*/
|
|
33
34
|
orientation?: 'horizontal' | 'vertical';
|
|
34
35
|
/**
|
|
35
36
|
* Sets inline padding on the Stack wrapper using one token for both sides or a `[start, end]` tuple.
|
|
36
37
|
*
|
|
37
|
-
* @
|
|
38
|
+
* @defaultValue No inline padding.
|
|
38
39
|
*/
|
|
39
40
|
hPadding?: SeparatorAxisPadding;
|
|
40
41
|
/**
|
|
41
42
|
* Sets block padding on the Stack wrapper using one token for both sides or a `[start, end]` tuple.
|
|
42
43
|
*
|
|
43
|
-
* @
|
|
44
|
+
* @defaultValue No block padding.
|
|
44
45
|
*/
|
|
45
46
|
vPadding?: SeparatorAxisPadding;
|
|
47
|
+
/**
|
|
48
|
+
* Caps the Stack wrapper inline size.
|
|
49
|
+
*
|
|
50
|
+
* @defaultValue No max width constraint.
|
|
51
|
+
*/
|
|
52
|
+
maxWidth?: StackProps['maxWidth'];
|
|
46
53
|
/**
|
|
47
54
|
* Sets the line thickness preset.
|
|
48
55
|
*
|
|
49
|
-
* @
|
|
56
|
+
* @defaultValue 's'
|
|
50
57
|
*/
|
|
51
58
|
size?: SeparatorSize;
|
|
52
59
|
/**
|
|
53
60
|
* Sets the separator line variant through `--vui-separator-border-style`.
|
|
54
61
|
*
|
|
55
|
-
* @
|
|
62
|
+
* @defaultValue 'solid'
|
|
56
63
|
*/
|
|
57
64
|
variant?: React.CSSProperties['borderStyle'];
|
|
58
65
|
};
|
|
@@ -10,7 +10,7 @@ var separatorSizeValues = {
|
|
|
10
10
|
m: 2,
|
|
11
11
|
l: 3
|
|
12
12
|
};
|
|
13
|
-
var Separator = ({ className, hPadding, orientation = "horizontal", ref, render, size = "s", style, variant = "solid", vPadding, ...otherProps }) => {
|
|
13
|
+
var Separator = ({ className, hPadding, maxWidth, orientation = "horizontal", ref, render, size = "s", style, variant = "solid", vPadding, ...otherProps }) => {
|
|
14
14
|
const dynamicStyle = {
|
|
15
15
|
"--vui-separator-size": `${separatorSizeValues[size]}px`,
|
|
16
16
|
"--vui-separator-border-style": variant,
|
|
@@ -30,6 +30,7 @@ var Separator = ({ className, hPadding, orientation = "horizontal", ref, render,
|
|
|
30
30
|
...otherProps,
|
|
31
31
|
direction: orientation === "vertical" ? "row" : "column",
|
|
32
32
|
hPadding,
|
|
33
|
+
maxWidth,
|
|
33
34
|
vAlign: orientation === "vertical" ? "stretch" : "initial",
|
|
34
35
|
vPadding,
|
|
35
36
|
children: line
|
|
@@ -5,37 +5,37 @@ import type * as React from 'react';
|
|
|
5
5
|
* Includes standard `span` attributes such as `children`, `id`, `title`, and event handlers,
|
|
6
6
|
* plus Vira-owned shimmer tuning controls.
|
|
7
7
|
*
|
|
8
|
-
* @
|
|
8
|
+
* @defaultValue Native span pass-through props keep React defaults.
|
|
9
9
|
*/
|
|
10
10
|
export type ShimmerProps = React.ComponentPropsWithoutRef<'span'> & {
|
|
11
11
|
/**
|
|
12
12
|
* Sets the shimmer sweep duration using any valid CSS time string.
|
|
13
13
|
*
|
|
14
|
-
* @
|
|
14
|
+
* @defaultValue The CSS duration is `var(--duration-slowest)`.
|
|
15
15
|
*/
|
|
16
16
|
duration?: string;
|
|
17
17
|
/**
|
|
18
18
|
* Sets the shimmer highlight spread using any valid CSS length string.
|
|
19
19
|
*
|
|
20
|
-
* @
|
|
20
|
+
* @defaultValue The CSS spread is `calc(3ch + var(--space-2xl))`.
|
|
21
21
|
*/
|
|
22
22
|
spread?: string;
|
|
23
23
|
/**
|
|
24
24
|
* Sets the shimmer gradient angle offset using any valid CSS angle string.
|
|
25
25
|
*
|
|
26
|
-
* @
|
|
26
|
+
* @defaultValue The CSS angle offset is `0deg`.
|
|
27
27
|
*/
|
|
28
28
|
angle?: string;
|
|
29
29
|
/**
|
|
30
30
|
* Overrides the shimmer highlight color when relative base lightness tuning is not used.
|
|
31
31
|
*
|
|
32
|
-
* @
|
|
32
|
+
* @defaultValue The highlight increases base `currentColor` lightness.
|
|
33
33
|
*/
|
|
34
34
|
highlightColor?: string;
|
|
35
35
|
/**
|
|
36
36
|
* Ref forwarded to the rendered shimmer root element.
|
|
37
37
|
*
|
|
38
|
-
* @
|
|
38
|
+
* @defaultValue No ref is attached.
|
|
39
39
|
*/
|
|
40
40
|
ref?: React.Ref<HTMLSpanElement>;
|
|
41
41
|
};
|
|
@@ -6,31 +6,31 @@ import type * as React from 'react';
|
|
|
6
6
|
* Zero-layout-shift shimmer wrapper sized by hidden children. Includes standard `div`
|
|
7
7
|
* pass-through props plus Vira-owned shimmer controls.
|
|
8
8
|
*
|
|
9
|
-
* @
|
|
9
|
+
* @defaultValue Native div pass-through props keep React defaults.
|
|
10
10
|
*/
|
|
11
11
|
export type SkeletonOverlayProps = React.ComponentPropsWithRef<'div'> & {
|
|
12
12
|
/**
|
|
13
13
|
* Supplies placeholder content whose layout and dimensions define the skeleton bounding box.
|
|
14
14
|
*
|
|
15
|
-
* @
|
|
15
|
+
* @defaultValue No default; consumer must provide children.
|
|
16
16
|
*/
|
|
17
17
|
children: React.ReactNode;
|
|
18
18
|
/**
|
|
19
19
|
* Enables or disables the shimmer animation.
|
|
20
20
|
*
|
|
21
|
-
* @
|
|
21
|
+
* @defaultValue true
|
|
22
22
|
*/
|
|
23
23
|
animate?: boolean;
|
|
24
24
|
/**
|
|
25
25
|
* Sets the corner radius from the Vira radius token scale.
|
|
26
26
|
*
|
|
27
|
-
* @
|
|
27
|
+
* @defaultValue 's'
|
|
28
28
|
*/
|
|
29
29
|
radius?: ThemeTypes['radius'];
|
|
30
30
|
/**
|
|
31
31
|
* Sets the shimmer sweep duration from the Vira duration token scale.
|
|
32
32
|
*
|
|
33
|
-
* @
|
|
33
|
+
* @defaultValue 'slow'
|
|
34
34
|
*/
|
|
35
35
|
duration?: ThemeTypes['duration'];
|
|
36
36
|
};
|
|
@@ -7,55 +7,55 @@ import type * as React from 'react';
|
|
|
7
7
|
* GPU shimmer block primitive. Includes standard `div` pass-through props such as `id`, `title`,
|
|
8
8
|
* data attributes, and event handlers, plus Vira-owned sizing and shimmer controls.
|
|
9
9
|
*
|
|
10
|
-
* @
|
|
10
|
+
* @defaultValue Native div pass-through props keep React defaults.
|
|
11
11
|
*/
|
|
12
12
|
export type SkeletonProps = React.ComponentPropsWithoutRef<'div'> & {
|
|
13
13
|
/**
|
|
14
14
|
* Sets the skeleton inline size using any valid CSS size string.
|
|
15
15
|
*
|
|
16
|
-
* @
|
|
16
|
+
* @defaultValue The skeleton sizes from context, constrained by the CSS minimum.
|
|
17
17
|
*/
|
|
18
18
|
width?: string;
|
|
19
19
|
/**
|
|
20
20
|
* Sets the skeleton block size using any valid CSS size string.
|
|
21
21
|
*
|
|
22
|
-
* @
|
|
22
|
+
* @defaultValue The skeleton sizes from context, constrained by the CSS minimum.
|
|
23
23
|
*/
|
|
24
24
|
height?: string;
|
|
25
25
|
/**
|
|
26
26
|
* Sets the skeleton minimum inline size using any valid CSS size string.
|
|
27
27
|
*
|
|
28
|
-
* @
|
|
28
|
+
* @defaultValue The CSS minimum inline size is `2rem`.
|
|
29
29
|
*/
|
|
30
30
|
minWidth?: string;
|
|
31
31
|
/**
|
|
32
32
|
* Sets the skeleton minimum block size using any valid CSS size string.
|
|
33
33
|
*
|
|
34
|
-
* @
|
|
34
|
+
* @defaultValue The CSS minimum block size is `1rem`.
|
|
35
35
|
*/
|
|
36
36
|
minHeight?: string;
|
|
37
37
|
/**
|
|
38
38
|
* Enables or disables the shimmer animation.
|
|
39
39
|
*
|
|
40
|
-
* @
|
|
40
|
+
* @defaultValue true
|
|
41
41
|
*/
|
|
42
42
|
animate?: boolean;
|
|
43
43
|
/**
|
|
44
44
|
* Sets the corner radius from the Vira radius token scale.
|
|
45
45
|
*
|
|
46
|
-
* @
|
|
46
|
+
* @defaultValue 's'
|
|
47
47
|
*/
|
|
48
48
|
radius?: ThemeTypes['radius'];
|
|
49
49
|
/**
|
|
50
50
|
* Sets the shimmer sweep duration from the Vira duration token scale.
|
|
51
51
|
*
|
|
52
|
-
* @
|
|
52
|
+
* @defaultValue 'slow'
|
|
53
53
|
*/
|
|
54
54
|
duration?: ThemeTypes['duration'];
|
|
55
55
|
/**
|
|
56
56
|
* Ref forwarded to the rendered skeleton root element.
|
|
57
57
|
*
|
|
58
|
-
* @
|
|
58
|
+
* @defaultValue No ref is attached.
|
|
59
59
|
*/
|
|
60
60
|
ref?: React.Ref<HTMLDivElement>;
|
|
61
61
|
};
|
|
@@ -7,31 +7,31 @@ import type * as React from 'react';
|
|
|
7
7
|
* Includes Base UI slider root props such as `value`, `defaultValue`, `min`, `max`, `step`,
|
|
8
8
|
* `disabled`, `orientation`, and change handlers, plus optional field copy and thumb labeling.
|
|
9
9
|
*
|
|
10
|
-
* @
|
|
10
|
+
* @defaultValue Base UI pass-through props keep upstream defaults.
|
|
11
11
|
*/
|
|
12
12
|
export type SliderProps = SliderRoot.Props & FieldRoot.Props & {
|
|
13
13
|
/**
|
|
14
14
|
* Visible label rendered with shared internal `FieldLabel`.
|
|
15
15
|
*
|
|
16
|
-
* @
|
|
16
|
+
* @defaultValue No label is rendered.
|
|
17
17
|
*/
|
|
18
18
|
label?: React.ReactNode;
|
|
19
19
|
/**
|
|
20
20
|
* Helper copy rendered with `Field.Description` and `Text` while the field is valid.
|
|
21
21
|
*
|
|
22
|
-
* @
|
|
22
|
+
* @defaultValue No description is rendered.
|
|
23
23
|
*/
|
|
24
24
|
description?: React.ReactNode;
|
|
25
25
|
/**
|
|
26
26
|
* Error copy rendered with `Field.Error` and `Text` in the same slot as `description`.
|
|
27
27
|
*
|
|
28
|
-
* @
|
|
28
|
+
* @defaultValue No static error copy is rendered.
|
|
29
29
|
*/
|
|
30
30
|
error?: React.ReactNode;
|
|
31
31
|
/**
|
|
32
32
|
* Marks the slider as required and shows a required indicator on the label.
|
|
33
33
|
*
|
|
34
|
-
* @
|
|
34
|
+
* @defaultValue false
|
|
35
35
|
*/
|
|
36
36
|
required?: boolean;
|
|
37
37
|
/**
|
|
@@ -40,7 +40,7 @@ export type SliderProps = SliderRoot.Props & FieldRoot.Props & {
|
|
|
40
40
|
* Pass `true` for Base UI default formatting inside styled `Text`, or a
|
|
41
41
|
* function matching `Slider.Value` `children` to own the value slot (no `Text`).
|
|
42
42
|
*
|
|
43
|
-
* @
|
|
43
|
+
* @defaultValue Value UI is hidden.
|
|
44
44
|
*/
|
|
45
45
|
renderValue?: boolean | Exclude<React.ComponentProps<typeof PrimitiveSlider.Value>['children'], null | undefined>;
|
|
46
46
|
/**
|
|
@@ -50,7 +50,7 @@ export type SliderProps = SliderRoot.Props & FieldRoot.Props & {
|
|
|
50
50
|
* Pass a two-element tuple to name each range thumb in order; on a single-thumb slider only the
|
|
51
51
|
* first tuple value is applied.
|
|
52
52
|
*
|
|
53
|
-
* @
|
|
53
|
+
* @defaultValue No default; required when `label` is omitted and thumbs need distinct accessible names.
|
|
54
54
|
*/
|
|
55
55
|
thumbAriaLabel?: string | readonly [string, string];
|
|
56
56
|
};
|
|
@@ -4,19 +4,19 @@ export type SpinnerProps = Omit<React.ComponentProps<'svg'>, 'color'> & {
|
|
|
4
4
|
/**
|
|
5
5
|
* Sets the rendered spinner size.
|
|
6
6
|
*
|
|
7
|
-
* @
|
|
7
|
+
* @defaultValue 'l'
|
|
8
8
|
*/
|
|
9
9
|
size?: 's' | 'm' | 'l';
|
|
10
10
|
/**
|
|
11
11
|
* Overrides the spinner fill color.
|
|
12
12
|
*
|
|
13
|
-
* @
|
|
13
|
+
* @defaultValue No default; inherits `currentColor`.
|
|
14
14
|
*/
|
|
15
15
|
color?: string;
|
|
16
16
|
/**
|
|
17
17
|
* Visual animation style.
|
|
18
18
|
*
|
|
19
|
-
* @
|
|
19
|
+
* @defaultValue 'bars'
|
|
20
20
|
*/
|
|
21
21
|
variant?: SpinnerVariant;
|
|
22
22
|
};
|
|
@@ -10,37 +10,37 @@ type StackAxisPadding = StackSpace | [StackSpace | 0, StackSpace | 0];
|
|
|
10
10
|
* Includes standard `div` attributes such as `id`, `role`, `title`, and event handlers,
|
|
11
11
|
* plus Vira-owned flex layout controls and Base UI `render` support for replacing the root element.
|
|
12
12
|
*
|
|
13
|
-
* @
|
|
13
|
+
* @defaultValue Base UI pass-through props keep upstream defaults.
|
|
14
14
|
*/
|
|
15
15
|
export type StackProps = React.ComponentPropsWithoutRef<'div'> & {
|
|
16
16
|
/**
|
|
17
17
|
* Replaces the default `div` root using Base UI render semantics.
|
|
18
18
|
*
|
|
19
|
-
* @
|
|
19
|
+
* @defaultValue The stack renders a `div` root.
|
|
20
20
|
*/
|
|
21
21
|
render?: useRender.RenderProp;
|
|
22
22
|
/**
|
|
23
23
|
* Ref forwarded to the rendered stack root element.
|
|
24
24
|
*
|
|
25
|
-
* @
|
|
25
|
+
* @defaultValue No ref is attached.
|
|
26
26
|
*/
|
|
27
27
|
ref?: React.Ref<HTMLElement>;
|
|
28
28
|
/**
|
|
29
29
|
* Renders children across rows or columns using the chosen flex direction.
|
|
30
30
|
*
|
|
31
|
-
* @
|
|
31
|
+
* @defaultValue 'column'
|
|
32
32
|
*/
|
|
33
33
|
direction?: 'row' | 'column' | 'row-reverse' | 'column-reverse';
|
|
34
34
|
/**
|
|
35
35
|
* Displays the stack as `inline-flex` instead of `flex`.
|
|
36
36
|
*
|
|
37
|
-
* @
|
|
37
|
+
* @defaultValue false
|
|
38
38
|
*/
|
|
39
39
|
inline?: boolean;
|
|
40
40
|
/**
|
|
41
41
|
* Allows direct children to wrap onto additional lines when space is constrained.
|
|
42
42
|
*
|
|
43
|
-
* @
|
|
43
|
+
* @defaultValue false
|
|
44
44
|
*/
|
|
45
45
|
wrap?: boolean;
|
|
46
46
|
/**
|
|
@@ -50,7 +50,7 @@ export type StackProps = React.ComponentPropsWithoutRef<'div'> & {
|
|
|
50
50
|
* Does not set the stack root's own inline size — use `fullWidth` when this stack must
|
|
51
51
|
* fill its parent width (e.g. centered shell with `maxWidth`, or a full-bleed Button column).
|
|
52
52
|
*
|
|
53
|
-
* @
|
|
53
|
+
* @defaultValue false
|
|
54
54
|
*/
|
|
55
55
|
expandChildren?: boolean;
|
|
56
56
|
/**
|
|
@@ -61,55 +61,55 @@ export type StackProps = React.ComponentPropsWithoutRef<'div'> & {
|
|
|
61
61
|
* Use with `maxWidth` under a parent `hAlign="center"` for a fluid, capped, centered shell.
|
|
62
62
|
* Orthogonal to `expandChildren` (self size vs children grow).
|
|
63
63
|
*
|
|
64
|
-
* @
|
|
64
|
+
* @defaultValue false
|
|
65
65
|
*/
|
|
66
66
|
fullWidth?: boolean;
|
|
67
67
|
/**
|
|
68
68
|
* Sets the gap between flex rows using the Vira space token scale.
|
|
69
69
|
*
|
|
70
|
-
* @
|
|
70
|
+
* @defaultValue No row gap.
|
|
71
71
|
*/
|
|
72
72
|
rowGap?: StackSpace;
|
|
73
73
|
/**
|
|
74
74
|
* Sets the gap between flex columns using the Vira space token scale.
|
|
75
75
|
*
|
|
76
|
-
* @
|
|
76
|
+
* @defaultValue No column gap.
|
|
77
77
|
*/
|
|
78
78
|
columnGap?: StackSpace;
|
|
79
79
|
/**
|
|
80
80
|
* Aligns content on the horizontal axis from the consumer point of view.
|
|
81
81
|
*
|
|
82
|
-
* @
|
|
82
|
+
* @defaultValue 'initial'
|
|
83
83
|
*/
|
|
84
84
|
hAlign?: StackAlignment;
|
|
85
85
|
/**
|
|
86
86
|
* Aligns content on the vertical axis from the consumer point of view.
|
|
87
87
|
*
|
|
88
|
-
* @
|
|
88
|
+
* @defaultValue 'initial'
|
|
89
89
|
*/
|
|
90
90
|
vAlign?: StackAlignment;
|
|
91
91
|
/**
|
|
92
92
|
* Sets inline padding using one token for both sides or a `[start, end]` tuple.
|
|
93
93
|
*
|
|
94
|
-
* @
|
|
94
|
+
* @defaultValue No inline padding.
|
|
95
95
|
*/
|
|
96
96
|
hPadding?: StackAxisPadding;
|
|
97
97
|
/**
|
|
98
98
|
* Sets block padding using one token for both sides or a `[start, end]` tuple.
|
|
99
99
|
*
|
|
100
|
-
* @
|
|
100
|
+
* @defaultValue No block padding.
|
|
101
101
|
*/
|
|
102
102
|
vPadding?: StackAxisPadding;
|
|
103
103
|
/**
|
|
104
104
|
* Applies a maximum width value to the stack root.
|
|
105
105
|
*
|
|
106
|
-
* @
|
|
106
|
+
* @defaultValue No max width constraint.
|
|
107
107
|
*/
|
|
108
108
|
maxWidth?: string;
|
|
109
109
|
/**
|
|
110
110
|
* Applies a minimum width value to the stack root.
|
|
111
111
|
*
|
|
112
|
-
* @
|
|
112
|
+
* @defaultValue No minimum width constraint.
|
|
113
113
|
*/
|
|
114
114
|
minWidth?: string;
|
|
115
115
|
/**
|
|
@@ -121,7 +121,7 @@ export type StackProps = React.ComponentPropsWithoutRef<'div'> & {
|
|
|
121
121
|
* Warning: inline-size containment can affect nested layout (e.g. cards inside Masonry).
|
|
122
122
|
* Use only when you need container queries against this specific Stack.
|
|
123
123
|
*
|
|
124
|
-
* @
|
|
124
|
+
* @defaultValue false
|
|
125
125
|
*/
|
|
126
126
|
enableContainer?: boolean;
|
|
127
127
|
};
|
|
@@ -5,31 +5,31 @@ import type * as React from 'react';
|
|
|
5
5
|
* Includes standard `figure` attributes such as `id`, `className`, and event handlers,
|
|
6
6
|
* plus Vira-owned turbulence tuning controls.
|
|
7
7
|
*
|
|
8
|
-
* @
|
|
8
|
+
* @defaultValue Native figure pass-through props keep React defaults.
|
|
9
9
|
*/
|
|
10
10
|
export type StaticNoiseProps = React.ComponentPropsWithRef<'figure'> & {
|
|
11
11
|
/**
|
|
12
12
|
* Sets the SVG turbulence `baseFrequency` for the internal noise filter.
|
|
13
13
|
*
|
|
14
|
-
* @
|
|
14
|
+
* @defaultValue 0.5
|
|
15
15
|
*/
|
|
16
16
|
baseFrequency?: number | string;
|
|
17
17
|
/**
|
|
18
18
|
* Sets the rendered overlay opacity.
|
|
19
19
|
*
|
|
20
|
-
* @
|
|
20
|
+
* @defaultValue 0.2
|
|
21
21
|
*/
|
|
22
22
|
opacity?: number;
|
|
23
23
|
/**
|
|
24
24
|
* Sets the rendered overlay mix blend mode.
|
|
25
25
|
*
|
|
26
|
-
* @
|
|
26
|
+
* @defaultValue 'difference'
|
|
27
27
|
*/
|
|
28
28
|
mixBlendMode?: React.CSSProperties['mixBlendMode'];
|
|
29
29
|
/**
|
|
30
30
|
* Animates the internal turbulence filter by cycling `feTurbulence` seed values.
|
|
31
31
|
*
|
|
32
|
-
* @
|
|
32
|
+
* @defaultValue false
|
|
33
33
|
*/
|
|
34
34
|
animate?: boolean;
|
|
35
35
|
};
|