@hydrateless/react 0.5.0 → 0.7.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/README.md +29 -23
- package/dist/index.d.ts +210 -68
- package/dist/index.js +239 -186
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -1,99 +1,166 @@
|
|
|
1
1
|
import * as react from 'react';
|
|
2
2
|
import { DependencyList, RefObject, HTMLAttributes, ReactNode, ButtonHTMLAttributes, LiHTMLAttributes, AnchorHTMLAttributes, ReactElement, InputHTMLAttributes, TextareaHTMLAttributes, SelectHTMLAttributes, LabelHTMLAttributes, ProgressHTMLAttributes } from 'react';
|
|
3
|
-
import
|
|
4
|
-
|
|
3
|
+
import * as _hydrateless_enhancers from '@hydrateless/enhancers';
|
|
4
|
+
import { EnhancerHandle, AccordionApi, DropdownApi, TabsApi, EnhanceTocOptions, TooltipApi, EnhanceTabsOptions, EnhanceDropdownOptions, EnhanceMenuOptions, ToastApi, EnhanceComboboxOptions } from '@hydrateless/enhancers';
|
|
5
|
+
export { AccordionApi, ComboboxApi, Disposer, DrawerApi, DropdownApi, EnhancerHandle, ModalApi, PopoverApi, TabsApi, ToastApi, TooltipApi } from '@hydrateless/enhancers';
|
|
5
6
|
|
|
6
7
|
/**
|
|
7
8
|
* Attach any Hydrateless enhancer to a DOM node for the lifetime of a
|
|
8
|
-
* component. Returns a ref to spread onto the element you want enhanced
|
|
9
|
-
*
|
|
10
|
-
*
|
|
9
|
+
* component. Returns a ref to spread onto the element you want enhanced plus
|
|
10
|
+
* a ref to the enhancer's imperative API (e.g. `setValue`/`setOpen`). The
|
|
11
|
+
* instance is destroyed automatically on unmount (and before re-running when
|
|
12
|
+
* `deps` change), so there are no leaked listeners across renders.
|
|
11
13
|
*
|
|
12
14
|
* ```tsx
|
|
13
|
-
* const ref = useEnhancer<HTMLDivElement>(enhanceTabs);
|
|
15
|
+
* const { ref, api } = useEnhancer<HTMLDivElement, TabsApi>((el) => enhanceTabs(el));
|
|
16
|
+
* // api.current?.setValue('two');
|
|
14
17
|
* return <div data-hl-tabs ref={ref}>…</div>;
|
|
15
18
|
* ```
|
|
16
19
|
*/
|
|
17
|
-
declare function useEnhancer<T extends HTMLElement = HTMLElement>(enhance: (container: HTMLElement) =>
|
|
20
|
+
declare function useEnhancer<T extends HTMLElement = HTMLElement, Api = null>(enhance: (container: HTMLElement) => EnhancerHandle<Api>, deps?: DependencyList): {
|
|
21
|
+
ref: RefObject<T | null>;
|
|
22
|
+
api: RefObject<Api | null>;
|
|
23
|
+
};
|
|
18
24
|
|
|
19
25
|
/** Ref hook that wires tabs ARIA + keyboard navigation onto a container. */
|
|
20
|
-
declare const useTabs: <T extends HTMLElement = HTMLDivElement>() =>
|
|
26
|
+
declare const useTabs: <T extends HTMLElement = HTMLDivElement>() => {
|
|
27
|
+
ref: react.RefObject<T | null>;
|
|
28
|
+
api: react.RefObject<TabsApi | null>;
|
|
29
|
+
};
|
|
21
30
|
/** Ref hook that wires a dropdown menu onto a container. */
|
|
22
|
-
declare const useDropdown: <T extends HTMLElement = HTMLDivElement>() =>
|
|
31
|
+
declare const useDropdown: <T extends HTMLElement = HTMLDivElement>() => {
|
|
32
|
+
ref: react.RefObject<T | null>;
|
|
33
|
+
api: react.RefObject<DropdownApi | null>;
|
|
34
|
+
};
|
|
23
35
|
/** Ref hook that wires tooltips onto all `[data-hl-tooltip]` triggers inside. */
|
|
24
|
-
declare const useTooltip: <T extends HTMLElement = HTMLElement>() =>
|
|
36
|
+
declare const useTooltip: <T extends HTMLElement = HTMLElement>() => {
|
|
37
|
+
ref: react.RefObject<T | null>;
|
|
38
|
+
api: react.RefObject<TooltipApi | null>;
|
|
39
|
+
};
|
|
25
40
|
/** Ref hook that enforces single-open accordion behavior on a container. */
|
|
26
|
-
declare const useAccordion: <T extends HTMLElement = HTMLDivElement>(allowMultiple?: boolean) =>
|
|
41
|
+
declare const useAccordion: <T extends HTMLElement = HTMLDivElement>(allowMultiple?: boolean) => {
|
|
42
|
+
ref: react.RefObject<T | null>;
|
|
43
|
+
api: react.RefObject<AccordionApi | null>;
|
|
44
|
+
};
|
|
27
45
|
/** Ref hook that groups `[data-hl-disclosure]` elements for mutual exclusivity. */
|
|
28
|
-
declare const useDisclosureGroup: <T extends HTMLElement = HTMLElement>(allowMultiple?: boolean) =>
|
|
46
|
+
declare const useDisclosureGroup: <T extends HTMLElement = HTMLElement>(allowMultiple?: boolean) => {
|
|
47
|
+
ref: react.RefObject<T | null>;
|
|
48
|
+
api: react.RefObject<null>;
|
|
49
|
+
};
|
|
29
50
|
/** Ref hook that wires modal openers/closers + focus trap within a container. */
|
|
30
|
-
declare const useModalGroup: <T extends HTMLElement = HTMLElement>(closeOnBackdrop?: boolean) =>
|
|
51
|
+
declare const useModalGroup: <T extends HTMLElement = HTMLElement>(closeOnBackdrop?: boolean) => {
|
|
52
|
+
ref: react.RefObject<T | null>;
|
|
53
|
+
api: react.RefObject<_hydrateless_enhancers.DialogApi | null>;
|
|
54
|
+
};
|
|
31
55
|
/** Ref hook that builds a table of contents from the surrounding document. */
|
|
32
|
-
declare const useTocEnhancer: <T extends HTMLElement = HTMLElement>(options?: EnhanceTocOptions) =>
|
|
56
|
+
declare const useTocEnhancer: <T extends HTMLElement = HTMLElement>(options?: EnhanceTocOptions) => {
|
|
57
|
+
ref: react.RefObject<T | null>;
|
|
58
|
+
api: react.RefObject<null>;
|
|
59
|
+
};
|
|
33
60
|
|
|
61
|
+
/** Props for {@link Accordion}. */
|
|
34
62
|
interface AccordionProps extends HTMLAttributes<HTMLDivElement> {
|
|
35
63
|
/** Allow more than one panel to stay open at a time. */
|
|
36
64
|
allowMultiple?: boolean;
|
|
65
|
+
/** Controlled list of open item values (pair with `onValueChange`). */
|
|
66
|
+
value?: string[];
|
|
67
|
+
/** Initially open item values for uncontrolled usage. */
|
|
68
|
+
defaultValue?: string[];
|
|
69
|
+
/** Called with the open item values after every change. */
|
|
70
|
+
onValueChange?: (value: string[]) => void;
|
|
37
71
|
}
|
|
38
|
-
|
|
72
|
+
/**
|
|
73
|
+
* Accordion of native `<details>` items. Item values come from each
|
|
74
|
+
* `<AccordionItem value>`, defaulting to the index. Open state works
|
|
75
|
+
* uncontrolled (`defaultValue`, or `defaultOpen` on items) or controlled
|
|
76
|
+
* (`value` + `onValueChange`).
|
|
77
|
+
*/
|
|
78
|
+
declare function Accordion({ allowMultiple, value, defaultValue, onValueChange, children, ...rest }: AccordionProps): react.JSX.Element;
|
|
79
|
+
/** Props for {@link AccordionItem}. */
|
|
39
80
|
interface AccordionItemProps extends Omit<HTMLAttributes<HTMLDetailsElement>, 'title'> {
|
|
40
81
|
summary: ReactNode;
|
|
82
|
+
/** Stable value identifying this item; defaults to its index. */
|
|
83
|
+
value?: string;
|
|
41
84
|
defaultOpen?: boolean;
|
|
42
85
|
}
|
|
43
|
-
|
|
86
|
+
/** A single collapsible item within an {@link Accordion}, rendered as a native `<details>`. */
|
|
87
|
+
declare function AccordionItem({ summary, value, defaultOpen, children, ...rest }: AccordionItemProps): react.JSX.Element;
|
|
44
88
|
|
|
89
|
+
/** Props for {@link Disclosure}. */
|
|
45
90
|
interface DisclosureProps extends Omit<HTMLAttributes<HTMLDetailsElement>, 'title'> {
|
|
46
91
|
summary: ReactNode;
|
|
47
92
|
defaultOpen?: boolean;
|
|
48
93
|
}
|
|
49
94
|
/**
|
|
50
|
-
* A single expandable section. Purely presentational
|
|
95
|
+
* A single expandable section. Purely presentational: native `<details>`
|
|
51
96
|
* handles open/close, so no enhancer is required for a lone disclosure. Use
|
|
52
97
|
* `useEnhancer(enhanceDisclosure)` on a wrapper if you need a mutually
|
|
53
98
|
* exclusive group.
|
|
54
99
|
*/
|
|
55
|
-
declare function Disclosure({ summary, defaultOpen, children, ...rest }: DisclosureProps): react.JSX.Element;
|
|
100
|
+
declare function Disclosure({ summary, defaultOpen, className, children, ...rest }: DisclosureProps): react.JSX.Element;
|
|
56
101
|
|
|
102
|
+
/** Props for {@link Tabs}. */
|
|
57
103
|
interface TabsProps extends HTMLAttributes<HTMLDivElement> {
|
|
58
104
|
/** `manual` (default): arrows move focus, Enter/Space activates. `automatic`: arrows activate immediately. */
|
|
59
105
|
activation?: EnhanceTabsOptions['activation'];
|
|
60
106
|
orientation?: EnhanceTabsOptions['orientation'];
|
|
107
|
+
/** Controlled value of the selected tab (pair with `onValueChange`). */
|
|
108
|
+
value?: string;
|
|
109
|
+
/** Initial value for uncontrolled usage. */
|
|
110
|
+
defaultValue?: string;
|
|
111
|
+
/** Called with the new tab value after every selection change. */
|
|
112
|
+
onValueChange?: (value: string) => void;
|
|
61
113
|
}
|
|
62
114
|
/**
|
|
63
115
|
* Tabbed interface root. Compose with `<TabList>`, `<Tab>`, and `<TabPanel>`.
|
|
64
116
|
* The enhancer wires ARIA roles, roving tabindex, and arrow-key navigation
|
|
65
|
-
* once the markup is mounted.
|
|
117
|
+
* once the markup is mounted. Tab values come from each `<Tab value>`,
|
|
118
|
+
* defaulting to the index; selection works uncontrolled (`defaultValue`) or
|
|
119
|
+
* controlled (`value` + `onValueChange`).
|
|
66
120
|
*
|
|
67
121
|
* ```tsx
|
|
68
|
-
* <Tabs>
|
|
122
|
+
* <Tabs value={tab} onValueChange={setTab}>
|
|
69
123
|
* <TabList>
|
|
70
|
-
* <Tab>Overview</Tab>
|
|
71
|
-
* <Tab>Install</Tab>
|
|
124
|
+
* <Tab value="overview">Overview</Tab>
|
|
125
|
+
* <Tab value="install">Install</Tab>
|
|
72
126
|
* </TabList>
|
|
73
127
|
* <TabPanel>Zero runtime by default.</TabPanel>
|
|
74
128
|
* <TabPanel>npm install hydrateless</TabPanel>
|
|
75
129
|
* </Tabs>
|
|
76
130
|
* ```
|
|
77
131
|
*/
|
|
78
|
-
declare function Tabs({ activation, orientation, children, ...rest }: TabsProps): react.JSX.Element;
|
|
132
|
+
declare function Tabs({ activation, orientation, value, defaultValue, onValueChange, children, ...rest }: TabsProps): react.JSX.Element;
|
|
133
|
+
/** Props for {@link TabList}. */
|
|
79
134
|
type TabListProps = HTMLAttributes<HTMLDivElement>;
|
|
80
135
|
/** The row of tab triggers. Renders `role="tablist"`. */
|
|
81
136
|
declare function TabList({ children, ...rest }: TabListProps): react.JSX.Element;
|
|
82
|
-
|
|
137
|
+
/** Props for {@link Tab}. */
|
|
138
|
+
interface TabProps extends ButtonHTMLAttributes<HTMLButtonElement> {
|
|
139
|
+
/** Stable value identifying this tab; defaults to its index. */
|
|
140
|
+
value?: string;
|
|
141
|
+
}
|
|
83
142
|
/** A single tab trigger. Renders `role="tab"`. */
|
|
84
|
-
declare function Tab({ children, type, ...rest }: TabProps): react.JSX.Element;
|
|
143
|
+
declare function Tab({ children, type, value, ...rest }: TabProps): react.JSX.Element;
|
|
144
|
+
/** Props for {@link TabPanel}. */
|
|
85
145
|
type TabPanelProps = HTMLAttributes<HTMLDivElement>;
|
|
86
146
|
/** Content for the matching tab. Renders `role="tabpanel"`. */
|
|
87
147
|
declare function TabPanel({ children, ...rest }: TabPanelProps): react.JSX.Element;
|
|
88
148
|
|
|
149
|
+
/** Props for {@link Dropdown}. */
|
|
89
150
|
interface DropdownProps extends HTMLAttributes<HTMLDivElement> {
|
|
90
151
|
placement?: EnhanceDropdownOptions['placement'];
|
|
152
|
+
/** Controlled open state (pair with `onOpenChange`). */
|
|
153
|
+
open?: boolean;
|
|
154
|
+
/** Open the menu initially for uncontrolled usage. */
|
|
155
|
+
defaultOpen?: boolean;
|
|
156
|
+
/** Called after the menu opens or closes. */
|
|
157
|
+
onOpenChange?: (open: boolean) => void;
|
|
91
158
|
}
|
|
92
159
|
/**
|
|
93
160
|
* Button-triggered menu following the WAI-ARIA menu-button pattern. Compose with
|
|
94
161
|
* `<DropdownTrigger>`, `<DropdownMenu>`, `<DropdownItem>`, and
|
|
95
162
|
* `<DropdownSeparator>`. The enhancer adds keyboard navigation, typeahead, and
|
|
96
|
-
* `aria-expanded`/`role` wiring.
|
|
163
|
+
* `aria-expanded`/`role` wiring; open state works uncontrolled or controlled.
|
|
97
164
|
*
|
|
98
165
|
* ```tsx
|
|
99
166
|
* <Dropdown>
|
|
@@ -106,23 +173,28 @@ interface DropdownProps extends HTMLAttributes<HTMLDivElement> {
|
|
|
106
173
|
* </Dropdown>
|
|
107
174
|
* ```
|
|
108
175
|
*/
|
|
109
|
-
declare function Dropdown({ placement, children, ...rest }: DropdownProps): react.JSX.Element;
|
|
176
|
+
declare function Dropdown({ placement, open, defaultOpen, onOpenChange, children, ...rest }: DropdownProps): react.JSX.Element;
|
|
177
|
+
/** Props for {@link DropdownTrigger}. */
|
|
110
178
|
type DropdownTriggerProps = ButtonHTMLAttributes<HTMLButtonElement>;
|
|
111
179
|
/** The button that opens the menu. */
|
|
112
180
|
declare function DropdownTrigger({ children, type, ...rest }: DropdownTriggerProps): react.JSX.Element;
|
|
181
|
+
/** Props for {@link DropdownMenu}. */
|
|
113
182
|
type DropdownMenuProps = HTMLAttributes<HTMLUListElement>;
|
|
114
183
|
/** The menu surface; holds `<DropdownItem>` and `<DropdownSeparator>`. */
|
|
115
184
|
declare function DropdownMenu({ children, ...rest }: DropdownMenuProps): react.JSX.Element;
|
|
185
|
+
/** Props for {@link DropdownItem}. */
|
|
116
186
|
interface DropdownItemProps extends ButtonHTMLAttributes<HTMLButtonElement> {
|
|
117
187
|
/** Convenience handler fired on click; you can also pass `onClick`. */
|
|
118
188
|
onSelect?: () => void;
|
|
119
189
|
}
|
|
120
190
|
/** A selectable menu item (`role="menuitem"`). */
|
|
121
191
|
declare function DropdownItem({ children, onSelect, onClick, type, ...rest }: DropdownItemProps): react.JSX.Element;
|
|
192
|
+
/** Props for {@link DropdownSeparator}. */
|
|
122
193
|
type DropdownSeparatorProps = Omit<LiHTMLAttributes<HTMLLIElement>, 'role'>;
|
|
123
194
|
/** A visual divider between groups of items. */
|
|
124
195
|
declare function DropdownSeparator(props: DropdownSeparatorProps): react.JSX.Element;
|
|
125
196
|
|
|
197
|
+
/** Props for {@link Menu}. */
|
|
126
198
|
interface MenuProps extends HTMLAttributes<HTMLUListElement> {
|
|
127
199
|
orientation?: EnhanceMenuOptions['orientation'];
|
|
128
200
|
}
|
|
@@ -139,6 +211,7 @@ interface MenuProps extends HTMLAttributes<HTMLUListElement> {
|
|
|
139
211
|
* ```
|
|
140
212
|
*/
|
|
141
213
|
declare function Menu({ orientation, children, ...rest }: MenuProps): react.JSX.Element;
|
|
214
|
+
/** Props for {@link MenuItem}. */
|
|
142
215
|
interface MenuItemProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'href' | 'type'> {
|
|
143
216
|
/** Render as a link instead of a button. */
|
|
144
217
|
href?: string;
|
|
@@ -155,26 +228,30 @@ interface MenuItemProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'h
|
|
|
155
228
|
*/
|
|
156
229
|
declare function MenuItem({ href, onSelect, onClick, submenu, anchorProps, children, ...rest }: MenuItemProps): react.JSX.Element;
|
|
157
230
|
|
|
158
|
-
|
|
231
|
+
/** Props for {@link Modal}. */
|
|
232
|
+
interface ModalProps extends Omit<HTMLAttributes<HTMLDialogElement>, 'title'> {
|
|
159
233
|
open: boolean;
|
|
160
|
-
|
|
234
|
+
/** Called after the dialog opens or closes (Escape, backdrop, close buttons). */
|
|
235
|
+
onOpenChange?: (open: boolean) => void;
|
|
161
236
|
closeOnBackdrop?: boolean;
|
|
162
237
|
}
|
|
163
238
|
/**
|
|
164
239
|
* Controlled dialog overlay. Driven by the `open` prop via the native
|
|
165
|
-
* `<dialog>` element
|
|
166
|
-
*
|
|
167
|
-
*
|
|
240
|
+
* `<dialog>` element and the modal enhancer, which adds a focus trap, body
|
|
241
|
+
* scroll-lock, and a background `inert` barrier. Compose with `<ModalHeader>`,
|
|
242
|
+
* `<ModalBody>`, and `<ModalFooter>`. Wire `onOpenChange` so Escape and
|
|
243
|
+
* backdrop clicks can update your state.
|
|
168
244
|
*
|
|
169
245
|
* ```tsx
|
|
170
|
-
* <Modal open={open}
|
|
246
|
+
* <Modal open={open} onOpenChange={setOpen}>
|
|
171
247
|
* <ModalHeader>Confirm</ModalHeader>
|
|
172
248
|
* <ModalBody>Are you sure?</ModalBody>
|
|
173
|
-
* <ModalFooter><Button onClick={
|
|
249
|
+
* <ModalFooter><Button onClick={() => setOpen(false)}>Close</Button></ModalFooter>
|
|
174
250
|
* </Modal>
|
|
175
251
|
* ```
|
|
176
252
|
*/
|
|
177
|
-
declare function Modal({ open,
|
|
253
|
+
declare function Modal({ open, onOpenChange, closeOnBackdrop, className, children, ...rest }: ModalProps): react.JSX.Element;
|
|
254
|
+
/** Props shared by the {@link Modal} section components. */
|
|
178
255
|
type ModalSectionProps = HTMLAttributes<HTMLDivElement>;
|
|
179
256
|
/** Modal heading region; its content labels the dialog for assistive tech. */
|
|
180
257
|
declare function ModalHeader({ className, ...rest }: ModalSectionProps): react.JSX.Element;
|
|
@@ -183,18 +260,22 @@ declare function ModalBody({ className, ...rest }: ModalSectionProps): react.JSX
|
|
|
183
260
|
/** Modal actions region. */
|
|
184
261
|
declare function ModalFooter({ className, ...rest }: ModalSectionProps): react.JSX.Element;
|
|
185
262
|
|
|
186
|
-
|
|
263
|
+
/** Props for {@link Drawer}. */
|
|
264
|
+
interface DrawerProps extends Omit<HTMLAttributes<HTMLDialogElement>, 'title'> {
|
|
187
265
|
open: boolean;
|
|
188
|
-
|
|
266
|
+
/** Called after the drawer opens or closes (Escape, backdrop, close buttons). */
|
|
267
|
+
onOpenChange?: (open: boolean) => void;
|
|
189
268
|
side?: 'left' | 'right';
|
|
190
269
|
closeOnBackdrop?: boolean;
|
|
191
270
|
}
|
|
192
271
|
/**
|
|
193
|
-
* Controlled off-canvas panel built on the native `<dialog>` element
|
|
272
|
+
* Controlled off-canvas panel built on the native `<dialog>` element and the
|
|
273
|
+
* drawer enhancer (focus trap, scroll-lock, background `inert`). Mirrors
|
|
194
274
|
* {@link Modal} but slides in from the chosen `side`. Compose with
|
|
195
275
|
* `<DrawerHeader>`, `<DrawerBody>`, and `<DrawerFooter>`.
|
|
196
276
|
*/
|
|
197
|
-
declare function Drawer({ open,
|
|
277
|
+
declare function Drawer({ open, onOpenChange, side, closeOnBackdrop, className, children, ...rest }: DrawerProps): react.JSX.Element;
|
|
278
|
+
/** Props shared by the {@link Drawer} section components. */
|
|
198
279
|
type DrawerSectionProps = HTMLAttributes<HTMLDivElement>;
|
|
199
280
|
/** Drawer heading region. */
|
|
200
281
|
declare function DrawerHeader({ className, ...rest }: DrawerSectionProps): react.JSX.Element;
|
|
@@ -203,17 +284,23 @@ declare function DrawerBody({ className, ...rest }: DrawerSectionProps): react.J
|
|
|
203
284
|
/** Drawer actions region. */
|
|
204
285
|
declare function DrawerFooter({ className, ...rest }: DrawerSectionProps): react.JSX.Element;
|
|
205
286
|
|
|
287
|
+
/** Props for {@link Popover}. */
|
|
206
288
|
interface PopoverProps extends HTMLAttributes<HTMLDivElement> {
|
|
207
289
|
open: boolean;
|
|
290
|
+
/** Called when the browser's light-dismiss (Escape or outside click) closes it. */
|
|
291
|
+
onOpenChange?: (open: boolean) => void;
|
|
208
292
|
children?: ReactNode;
|
|
209
293
|
}
|
|
210
294
|
/**
|
|
211
|
-
* Controlled floating content
|
|
212
|
-
*
|
|
213
|
-
* `
|
|
295
|
+
* Controlled floating content built on the native Popover API. The surface
|
|
296
|
+
* lives in the top layer with light-dismiss and Escape handled by the browser;
|
|
297
|
+
* visibility follows the `open` prop and `onOpenChange` fires when the browser
|
|
298
|
+
* dismisses it. Pair it with your own trigger button (toggling `open`) and
|
|
299
|
+
* position it with the `hydrateless/popover.css` styles.
|
|
214
300
|
*/
|
|
215
|
-
declare function Popover({ open, children, ...rest }: PopoverProps): react.JSX.Element;
|
|
301
|
+
declare function Popover({ open, onOpenChange, children, ...rest }: PopoverProps): react.JSX.Element;
|
|
216
302
|
|
|
303
|
+
/** Props for {@link Tooltip}. */
|
|
217
304
|
interface TooltipProps {
|
|
218
305
|
/** The hint text shown on hover/focus. */
|
|
219
306
|
label: ReactNode;
|
|
@@ -227,6 +314,7 @@ interface TooltipProps {
|
|
|
227
314
|
*/
|
|
228
315
|
declare function Tooltip({ label, children, id }: TooltipProps): react.JSX.Element;
|
|
229
316
|
|
|
317
|
+
/** Props for {@link Breadcrumb}. */
|
|
230
318
|
type BreadcrumbProps = HTMLAttributes<HTMLElement>;
|
|
231
319
|
/**
|
|
232
320
|
* Semantic breadcrumb navigation (`<nav> > <ol>`). CSS-only, no enhancer.
|
|
@@ -240,6 +328,7 @@ type BreadcrumbProps = HTMLAttributes<HTMLElement>;
|
|
|
240
328
|
* ```
|
|
241
329
|
*/
|
|
242
330
|
declare function Breadcrumb({ children, ...rest }: BreadcrumbProps): react.JSX.Element;
|
|
331
|
+
/** Props for {@link BreadcrumbItem}. */
|
|
243
332
|
interface BreadcrumbItemProps extends Omit<LiHTMLAttributes<HTMLLIElement>, 'children'> {
|
|
244
333
|
href?: string;
|
|
245
334
|
/** Marks the current page; renders a non-link with `aria-current="page"`. */
|
|
@@ -250,18 +339,21 @@ interface BreadcrumbItemProps extends Omit<LiHTMLAttributes<HTMLLIElement>, 'chi
|
|
|
250
339
|
/** A single crumb. Renders a link unless `current` (or no `href`) is set. */
|
|
251
340
|
declare function BreadcrumbItem({ href, current, anchorProps, children, ...rest }: BreadcrumbItemProps): react.JSX.Element;
|
|
252
341
|
|
|
342
|
+
/** Props for {@link Switch}. */
|
|
253
343
|
interface SwitchProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'type'> {
|
|
254
344
|
children?: ReactNode;
|
|
255
345
|
}
|
|
256
346
|
/** Toggle switch built on a native checkbox. CSS-only. */
|
|
257
347
|
declare function Switch({ children, className, ...rest }: SwitchProps): react.JSX.Element;
|
|
258
348
|
|
|
349
|
+
/** Props for {@link SkipLink}. */
|
|
259
350
|
type SkipLinkProps = AnchorHTMLAttributes<HTMLAnchorElement> & {
|
|
260
351
|
children?: ReactNode;
|
|
261
352
|
};
|
|
262
353
|
/** Accessibility skip-navigation link, visually hidden until focused. */
|
|
263
354
|
declare function SkipLink({ children, className, ...rest }: SkipLinkProps): react.JSX.Element;
|
|
264
355
|
|
|
356
|
+
/** Props for {@link Toc}. */
|
|
265
357
|
interface TocProps extends HTMLAttributes<HTMLElement> {
|
|
266
358
|
/** CSS selector for the content root to scan for headings. */
|
|
267
359
|
contentSelector?: string;
|
|
@@ -273,30 +365,40 @@ interface TocProps extends HTMLAttributes<HTMLElement> {
|
|
|
273
365
|
/** Auto-generated table of contents with optional scroll-spy. */
|
|
274
366
|
declare function Toc({ contentSelector, headings, scrollSpy, ...rest }: TocProps): react.JSX.Element;
|
|
275
367
|
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
368
|
+
/** Props for {@link ToastRegion}. */
|
|
369
|
+
type ToastRegionProps = HTMLAttributes<HTMLDivElement>;
|
|
370
|
+
/**
|
|
371
|
+
* The polite live region toasts render into. Render once near the root of
|
|
372
|
+
* your app to control where toasts appear; if omitted, the first `show()`
|
|
373
|
+
* call creates a region at the end of `<body>`.
|
|
374
|
+
*/
|
|
375
|
+
declare function ToastRegion(props: ToastRegionProps): react.JSX.Element;
|
|
279
376
|
/**
|
|
280
|
-
*
|
|
281
|
-
* {@link
|
|
377
|
+
* Access the imperative toast API (`show`/`dismiss`). Works with or without a
|
|
378
|
+
* mounted {@link ToastRegion}.
|
|
282
379
|
*/
|
|
283
|
-
declare function ToastProvider({ children }: ToastProviderProps): react.JSX.Element;
|
|
284
|
-
/** Access the toast API. Must be called within a {@link ToastProvider}. */
|
|
285
380
|
declare function useToast(): ToastApi;
|
|
286
381
|
|
|
382
|
+
/** Props for {@link Combobox}. */
|
|
287
383
|
interface ComboboxProps extends Omit<HTMLAttributes<HTMLDivElement>, 'onChange'> {
|
|
288
384
|
filter?: EnhanceComboboxOptions['filter'];
|
|
289
385
|
autoHighlight?: EnhanceComboboxOptions['autoHighlight'];
|
|
386
|
+
/** Controlled committed value (pair with `onValueChange`). */
|
|
387
|
+
value?: string;
|
|
388
|
+
/** Initial committed value for uncontrolled usage. */
|
|
389
|
+
defaultValue?: string;
|
|
290
390
|
/** Fires with the committed value when an option is selected. */
|
|
291
391
|
onValueChange?: (value: string) => void;
|
|
292
392
|
}
|
|
293
393
|
/**
|
|
294
394
|
* Editable combobox (input + listbox) implementing the APG pattern. Compose with
|
|
295
395
|
* `<ComboboxInput>`, `<ComboboxList>`, and `<ComboboxOption>`. The enhancer adds
|
|
296
|
-
* filtering, `aria-activedescendant` navigation, and selection
|
|
396
|
+
* filtering, `aria-activedescendant` navigation, and selection; the committed
|
|
397
|
+
* value works uncontrolled (`defaultValue`) or controlled (`value` +
|
|
398
|
+
* `onValueChange`).
|
|
297
399
|
*
|
|
298
400
|
* ```tsx
|
|
299
|
-
* <Combobox onValueChange={
|
|
401
|
+
* <Combobox value={fruit} onValueChange={setFruit}>
|
|
300
402
|
* <ComboboxInput placeholder="Search…" />
|
|
301
403
|
* <ComboboxList>
|
|
302
404
|
* <ComboboxOption value="apple">Apple</ComboboxOption>
|
|
@@ -305,22 +407,26 @@ interface ComboboxProps extends Omit<HTMLAttributes<HTMLDivElement>, 'onChange'>
|
|
|
305
407
|
* </Combobox>
|
|
306
408
|
* ```
|
|
307
409
|
*/
|
|
308
|
-
declare function Combobox({ filter, autoHighlight, onValueChange, children, ...rest }: ComboboxProps): react.JSX.Element;
|
|
410
|
+
declare function Combobox({ filter, autoHighlight, value, defaultValue, onValueChange, children, ...rest }: ComboboxProps): react.JSX.Element;
|
|
411
|
+
/** Props for {@link ComboboxInput}. */
|
|
309
412
|
interface ComboboxInputProps extends InputHTMLAttributes<HTMLInputElement> {
|
|
310
413
|
/** Apply the `hl-input` style. Defaults to `true`. */
|
|
311
414
|
styled?: boolean;
|
|
312
415
|
}
|
|
313
416
|
/** The combobox text field. */
|
|
314
417
|
declare function ComboboxInput({ styled, className, ...rest }: ComboboxInputProps): react.JSX.Element;
|
|
418
|
+
/** Props for {@link ComboboxList}. */
|
|
315
419
|
type ComboboxListProps = HTMLAttributes<HTMLUListElement>;
|
|
316
420
|
/** The option popup (`role="listbox"`). */
|
|
317
421
|
declare function ComboboxList({ children, ...rest }: ComboboxListProps): react.JSX.Element;
|
|
422
|
+
/** Props for {@link ComboboxOption}. */
|
|
318
423
|
interface ComboboxOptionProps extends Omit<LiHTMLAttributes<HTMLLIElement>, 'value'> {
|
|
319
424
|
value: string;
|
|
320
425
|
}
|
|
321
426
|
/** A selectable option. The `value` is committed on selection. */
|
|
322
427
|
declare function ComboboxOption({ value, children, ...rest }: ComboboxOptionProps): react.JSX.Element;
|
|
323
428
|
|
|
429
|
+
/** Props for {@link Command}. */
|
|
324
430
|
interface CommandProps extends Omit<HTMLAttributes<HTMLDivElement>, 'onSelect'> {
|
|
325
431
|
/** Lowercased key that opens the palette's dialog with Cmd/Ctrl. */
|
|
326
432
|
hotkey?: string;
|
|
@@ -334,20 +440,24 @@ interface CommandProps extends Omit<HTMLAttributes<HTMLDivElement>, 'onSelect'>
|
|
|
334
440
|
* runs the active item on Enter. Place inside a `<dialog>` to use `hotkey`.
|
|
335
441
|
*/
|
|
336
442
|
declare function Command({ hotkey, onSelect, children, ...rest }: CommandProps): react.JSX.Element;
|
|
443
|
+
/** Props for {@link CommandInput}. */
|
|
337
444
|
interface CommandInputProps extends InputHTMLAttributes<HTMLInputElement> {
|
|
338
445
|
styled?: boolean;
|
|
339
446
|
}
|
|
340
447
|
/** The palette search field. */
|
|
341
448
|
declare function CommandInput({ styled, className, ...rest }: CommandInputProps): react.JSX.Element;
|
|
449
|
+
/** Props for {@link CommandList}. */
|
|
342
450
|
type CommandListProps = HTMLAttributes<HTMLDivElement>;
|
|
343
451
|
/** The scrollable list of commands (`role="listbox"`). */
|
|
344
452
|
declare function CommandList({ children, ...rest }: CommandListProps): react.JSX.Element;
|
|
453
|
+
/** Props for {@link CommandGroup}. */
|
|
345
454
|
interface CommandGroupProps extends HTMLAttributes<HTMLDivElement> {
|
|
346
455
|
/** Optional heading shown above the grouped items. */
|
|
347
456
|
label?: ReactNode;
|
|
348
457
|
}
|
|
349
458
|
/** A labelled group of commands. */
|
|
350
459
|
declare function CommandGroup({ label, children, ...rest }: CommandGroupProps): react.JSX.Element;
|
|
460
|
+
/** Props for {@link CommandItem}. */
|
|
351
461
|
interface CommandItemProps extends Omit<HTMLAttributes<HTMLDivElement>, 'onSelect'> {
|
|
352
462
|
value: string;
|
|
353
463
|
/** Extra search terms for filtering. */
|
|
@@ -357,10 +467,12 @@ interface CommandItemProps extends Omit<HTMLAttributes<HTMLDivElement>, 'onSelec
|
|
|
357
467
|
}
|
|
358
468
|
/** A runnable command (`role="option"`). */
|
|
359
469
|
declare function CommandItem({ value, keywords, icon, children, ...rest }: CommandItemProps): react.JSX.Element;
|
|
470
|
+
/** Props for {@link CommandEmpty}. */
|
|
360
471
|
type CommandEmptyProps = HTMLAttributes<HTMLDivElement>;
|
|
361
472
|
/** Shown when no commands match the query. */
|
|
362
473
|
declare function CommandEmpty({ children, ...rest }: CommandEmptyProps): react.JSX.Element;
|
|
363
474
|
|
|
475
|
+
/** Props for {@link Input}. */
|
|
364
476
|
interface InputProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'size'> {
|
|
365
477
|
size?: 'sm' | 'md' | 'lg';
|
|
366
478
|
invalid?: boolean;
|
|
@@ -368,17 +480,20 @@ interface InputProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'size'>
|
|
|
368
480
|
/** Text input styled with the `hl-input` primitive. */
|
|
369
481
|
declare const Input: react.ForwardRefExoticComponent<InputProps & react.RefAttributes<HTMLInputElement>>;
|
|
370
482
|
|
|
483
|
+
/** Props for {@link Textarea}. */
|
|
371
484
|
interface TextareaProps extends TextareaHTMLAttributes<HTMLTextAreaElement> {
|
|
372
485
|
invalid?: boolean;
|
|
373
486
|
}
|
|
374
487
|
/** Multi-line text input styled with the `hl-textarea` primitive. */
|
|
375
488
|
declare const Textarea: react.ForwardRefExoticComponent<TextareaProps & react.RefAttributes<HTMLTextAreaElement>>;
|
|
376
489
|
|
|
490
|
+
/** A single option in a {@link Select}. */
|
|
377
491
|
interface SelectOption {
|
|
378
492
|
label: ReactNode;
|
|
379
493
|
value: string;
|
|
380
494
|
disabled?: boolean;
|
|
381
495
|
}
|
|
496
|
+
/** Props for {@link Select}. */
|
|
382
497
|
interface SelectProps extends Omit<SelectHTMLAttributes<HTMLSelectElement>, 'size'> {
|
|
383
498
|
size?: 'sm' | 'md' | 'lg';
|
|
384
499
|
invalid?: boolean;
|
|
@@ -392,18 +507,21 @@ interface SelectProps extends Omit<SelectHTMLAttributes<HTMLSelectElement>, 'siz
|
|
|
392
507
|
*/
|
|
393
508
|
declare const Select: react.ForwardRefExoticComponent<SelectProps & react.RefAttributes<HTMLSelectElement>>;
|
|
394
509
|
|
|
510
|
+
/** Props for {@link Checkbox}. */
|
|
395
511
|
interface CheckboxProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'type'> {
|
|
396
512
|
children?: ReactNode;
|
|
397
513
|
}
|
|
398
514
|
/** Checkbox built on a native `<input type="checkbox">`, label-wrapped. */
|
|
399
515
|
declare const Checkbox: react.ForwardRefExoticComponent<CheckboxProps & react.RefAttributes<HTMLInputElement>>;
|
|
400
516
|
|
|
517
|
+
/** Props for {@link Radio}. */
|
|
401
518
|
interface RadioProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'type'> {
|
|
402
519
|
children?: ReactNode;
|
|
403
520
|
value: string;
|
|
404
521
|
}
|
|
405
522
|
/** A single radio built on a native `<input type="radio">`, label-wrapped. */
|
|
406
523
|
declare const Radio: react.ForwardRefExoticComponent<RadioProps & react.RefAttributes<HTMLInputElement>>;
|
|
524
|
+
/** Props for {@link RadioGroup}. */
|
|
407
525
|
interface RadioGroupProps extends Omit<HTMLAttributes<HTMLDivElement>, 'onChange'> {
|
|
408
526
|
name?: string;
|
|
409
527
|
value?: string;
|
|
@@ -415,6 +533,7 @@ interface RadioGroupProps extends Omit<HTMLAttributes<HTMLDivElement>, 'onChange
|
|
|
415
533
|
*/
|
|
416
534
|
declare function RadioGroup({ name, value, onValueChange, className, children, ...rest }: RadioGroupProps): react.JSX.Element;
|
|
417
535
|
|
|
536
|
+
/** Props for {@link Field}. */
|
|
418
537
|
interface FieldProps extends HTMLAttributes<HTMLDivElement> {
|
|
419
538
|
id?: string;
|
|
420
539
|
invalid?: boolean;
|
|
@@ -436,6 +555,7 @@ declare function useField(): {
|
|
|
436
555
|
'aria-describedby': string | undefined;
|
|
437
556
|
'aria-invalid': true | undefined;
|
|
438
557
|
};
|
|
558
|
+
/** Props for {@link FieldLabel}. */
|
|
439
559
|
type FieldLabelProps = LabelHTMLAttributes<HTMLLabelElement>;
|
|
440
560
|
/** Label bound to the enclosing field's control via `htmlFor`. */
|
|
441
561
|
declare function FieldLabel({ className, children, ...rest }: FieldLabelProps): react.JSX.Element;
|
|
@@ -443,17 +563,20 @@ declare function FieldLabel({ className, children, ...rest }: FieldLabelProps):
|
|
|
443
563
|
declare function FieldHelp({ className, children, ...rest }: HTMLAttributes<HTMLParagraphElement>): react.JSX.Element;
|
|
444
564
|
/** Validation message; renders nothing unless given content. */
|
|
445
565
|
declare function FieldError({ className, children, ...rest }: HTMLAttributes<HTMLParagraphElement>): react.JSX.Element | null;
|
|
566
|
+
/** Props for {@link Fieldset}. */
|
|
446
567
|
interface FieldsetProps extends HTMLAttributes<HTMLFieldSetElement> {
|
|
447
568
|
legend?: ReactNode;
|
|
448
569
|
}
|
|
449
570
|
/** Grouped fields with an optional legend. */
|
|
450
571
|
declare function Fieldset({ legend, className, children, ...rest }: FieldsetProps): react.JSX.Element;
|
|
451
572
|
|
|
573
|
+
/** A single option in a {@link SegmentedControl}. */
|
|
452
574
|
interface SegmentedOption {
|
|
453
575
|
label: ReactNode;
|
|
454
576
|
value: string;
|
|
455
577
|
disabled?: boolean;
|
|
456
578
|
}
|
|
579
|
+
/** Props for {@link SegmentedControl}. */
|
|
457
580
|
interface SegmentedControlProps extends Omit<HTMLAttributes<HTMLDivElement>, 'onChange'> {
|
|
458
581
|
options: SegmentedOption[];
|
|
459
582
|
value?: string;
|
|
@@ -463,16 +586,18 @@ interface SegmentedControlProps extends Omit<HTMLAttributes<HTMLDivElement>, 'on
|
|
|
463
586
|
size?: 'sm' | 'md' | 'lg';
|
|
464
587
|
}
|
|
465
588
|
/**
|
|
466
|
-
* Segmented control
|
|
589
|
+
* Segmented control: `hl-segmented` radiogroup. Controlled via `value` or
|
|
467
590
|
* uncontrolled via `defaultValue`. Built on native radios for free keyboard
|
|
468
591
|
* navigation.
|
|
469
592
|
*/
|
|
470
593
|
declare function SegmentedControl({ options, value, defaultValue, onValueChange, name, size, className, ...rest }: SegmentedControlProps): react.JSX.Element;
|
|
471
594
|
|
|
595
|
+
/** Props for {@link Slider}. */
|
|
472
596
|
type SliderProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'type'>;
|
|
473
|
-
/** Range slider primitive
|
|
597
|
+
/** Range slider primitive: `<input type="range" class="hl-slider">`. */
|
|
474
598
|
declare const Slider: react.ForwardRefExoticComponent<SliderProps & react.RefAttributes<HTMLInputElement>>;
|
|
475
599
|
|
|
600
|
+
/** Props for {@link Button}. */
|
|
476
601
|
interface ButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
|
|
477
602
|
variant?: 'solid' | 'soft' | 'outline' | 'ghost' | 'link';
|
|
478
603
|
intent?: 'neutral' | 'primary' | 'danger' | 'success' | 'warning' | 'info';
|
|
@@ -484,39 +609,49 @@ interface ButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
|
|
|
484
609
|
/** Show a spinner and disable interaction. */
|
|
485
610
|
loading?: boolean;
|
|
486
611
|
}
|
|
487
|
-
/** Button primitive
|
|
612
|
+
/** Button primitive: `hl-button` with intent/variant/size modifiers. */
|
|
488
613
|
declare const Button: react.ForwardRefExoticComponent<ButtonProps & react.RefAttributes<HTMLButtonElement>>;
|
|
489
614
|
|
|
615
|
+
/** Props for {@link Alert}. */
|
|
490
616
|
interface AlertProps extends Omit<HTMLAttributes<HTMLDivElement>, 'title'> {
|
|
491
617
|
intent?: 'info' | 'success' | 'warning' | 'danger' | 'neutral';
|
|
492
618
|
title?: ReactNode;
|
|
493
619
|
/** Leading icon, rendered before the body. */
|
|
494
620
|
icon?: ReactNode;
|
|
495
621
|
}
|
|
496
|
-
/** Alert primitive
|
|
622
|
+
/** Alert primitive: `hl-alert` with intent, optional icon + title. */
|
|
497
623
|
declare const Alert: react.ForwardRefExoticComponent<AlertProps & react.RefAttributes<HTMLDivElement>>;
|
|
498
624
|
|
|
625
|
+
/** Props for {@link Badge}. */
|
|
499
626
|
interface BadgeProps extends HTMLAttributes<HTMLSpanElement> {
|
|
500
627
|
intent?: 'neutral' | 'primary' | 'danger' | 'success' | 'warning' | 'info';
|
|
501
628
|
variant?: 'soft' | 'solid' | 'outline';
|
|
502
629
|
size?: 'sm' | 'md';
|
|
503
630
|
}
|
|
504
|
-
/** Badge primitive
|
|
631
|
+
/** Badge primitive: `hl-badge` with intent/variant/size modifiers. */
|
|
505
632
|
declare const Badge: react.ForwardRefExoticComponent<BadgeProps & react.RefAttributes<HTMLSpanElement>>;
|
|
506
633
|
|
|
634
|
+
/** Props for {@link Card}. */
|
|
507
635
|
interface CardProps extends HTMLAttributes<HTMLDivElement> {
|
|
508
636
|
/** Hover/active elevation for clickable cards. */
|
|
509
637
|
interactive?: boolean;
|
|
510
638
|
}
|
|
511
|
-
/** Card container
|
|
639
|
+
/** Card container: `hl-card`. Compose with the Card.* parts. */
|
|
512
640
|
declare const Card: react.ForwardRefExoticComponent<CardProps & react.RefAttributes<HTMLDivElement>>;
|
|
641
|
+
/** Props shared by the {@link Card} section components. */
|
|
513
642
|
type CardSectionProps = HTMLAttributes<HTMLDivElement>;
|
|
643
|
+
/** Header region of a {@link Card}. */
|
|
514
644
|
declare const CardHeader: react.ForwardRefExoticComponent<CardSectionProps & react.RefAttributes<HTMLDivElement>>;
|
|
645
|
+
/** Body region of a {@link Card}. */
|
|
515
646
|
declare const CardBody: react.ForwardRefExoticComponent<CardSectionProps & react.RefAttributes<HTMLDivElement>>;
|
|
647
|
+
/** Footer region of a {@link Card}. */
|
|
516
648
|
declare const CardFooter: react.ForwardRefExoticComponent<CardSectionProps & react.RefAttributes<HTMLDivElement>>;
|
|
649
|
+
/** Title heading of a {@link Card}. */
|
|
517
650
|
declare const CardTitle: react.ForwardRefExoticComponent<HTMLAttributes<HTMLHeadingElement> & react.RefAttributes<HTMLHeadingElement>>;
|
|
651
|
+
/** Description text of a {@link Card}. */
|
|
518
652
|
declare const CardDescription: react.ForwardRefExoticComponent<HTMLAttributes<HTMLParagraphElement> & react.RefAttributes<HTMLParagraphElement>>;
|
|
519
653
|
|
|
654
|
+
/** Props for {@link Avatar}. */
|
|
520
655
|
interface AvatarProps extends HTMLAttributes<HTMLSpanElement> {
|
|
521
656
|
src?: string;
|
|
522
657
|
alt?: string;
|
|
@@ -525,12 +660,14 @@ interface AvatarProps extends HTMLAttributes<HTMLSpanElement> {
|
|
|
525
660
|
size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
|
|
526
661
|
shape?: 'circle' | 'square';
|
|
527
662
|
}
|
|
528
|
-
/** Avatar primitive
|
|
663
|
+
/** Avatar primitive: `hl-avatar` with image + graceful fallback. */
|
|
529
664
|
declare const Avatar: react.ForwardRefExoticComponent<AvatarProps & react.RefAttributes<HTMLSpanElement>>;
|
|
665
|
+
/** Props for {@link AvatarGroup}. */
|
|
530
666
|
type AvatarGroupProps = HTMLAttributes<HTMLDivElement>;
|
|
531
667
|
/** Overlapping stack of avatars. */
|
|
532
668
|
declare const AvatarGroup: react.ForwardRefExoticComponent<AvatarGroupProps & react.RefAttributes<HTMLDivElement>>;
|
|
533
669
|
|
|
670
|
+
/** Props for {@link Progress}. */
|
|
534
671
|
interface ProgressProps extends Omit<ProgressHTMLAttributes<HTMLProgressElement>, 'value'> {
|
|
535
672
|
/** Omit for an indeterminate bar. */
|
|
536
673
|
value?: number;
|
|
@@ -538,25 +675,28 @@ interface ProgressProps extends Omit<ProgressHTMLAttributes<HTMLProgressElement>
|
|
|
538
675
|
intent?: 'primary' | 'success' | 'warning' | 'danger' | 'info';
|
|
539
676
|
size?: 'sm' | 'md' | 'lg';
|
|
540
677
|
}
|
|
541
|
-
/** Progress primitive
|
|
678
|
+
/** Progress primitive: native `<progress class="hl-progress">`. */
|
|
542
679
|
declare const Progress: react.ForwardRefExoticComponent<ProgressProps & react.RefAttributes<HTMLProgressElement>>;
|
|
543
680
|
|
|
681
|
+
/** Props for {@link Spinner}. */
|
|
544
682
|
interface SpinnerProps extends HTMLAttributes<HTMLSpanElement> {
|
|
545
683
|
size?: 'sm' | 'md' | 'lg' | 'xl';
|
|
546
684
|
/** Accessible label; announced via `role="status"`. */
|
|
547
685
|
label?: string;
|
|
548
686
|
}
|
|
549
|
-
/** Spinner primitive
|
|
687
|
+
/** Spinner primitive: `hl-spinner`. Inherits `currentColor`. */
|
|
550
688
|
declare const Spinner: react.ForwardRefExoticComponent<SpinnerProps & react.RefAttributes<HTMLSpanElement>>;
|
|
551
689
|
|
|
690
|
+
/** Props for {@link Skeleton}. */
|
|
552
691
|
interface SkeletonProps extends HTMLAttributes<HTMLSpanElement> {
|
|
553
692
|
variant?: 'rect' | 'text' | 'circle';
|
|
554
693
|
width?: string | number;
|
|
555
694
|
height?: string | number;
|
|
556
695
|
}
|
|
557
|
-
/** Skeleton placeholder primitive
|
|
696
|
+
/** Skeleton placeholder primitive: `hl-skeleton`. */
|
|
558
697
|
declare const Skeleton: react.ForwardRefExoticComponent<SkeletonProps & react.RefAttributes<HTMLSpanElement>>;
|
|
559
698
|
|
|
699
|
+
/** Props for {@link Pagination}. */
|
|
560
700
|
interface PaginationProps extends Omit<HTMLAttributes<HTMLElement>, 'onChange'> {
|
|
561
701
|
page: number;
|
|
562
702
|
count: number;
|
|
@@ -568,22 +708,24 @@ interface PaginationProps extends Omit<HTMLAttributes<HTMLElement>, 'onChange'>
|
|
|
568
708
|
prevLabel?: ReactNode;
|
|
569
709
|
nextLabel?: ReactNode;
|
|
570
710
|
}
|
|
571
|
-
/** Pagination primitive
|
|
711
|
+
/** Pagination primitive: `hl-pagination` with smart ellipsis truncation. */
|
|
572
712
|
declare function Pagination({ page, count, onPageChange, siblingCount, showControls, prevLabel, nextLabel, className, ...rest }: PaginationProps): react.JSX.Element;
|
|
573
713
|
|
|
714
|
+
/** Props for {@link Kbd}. */
|
|
574
715
|
type KbdProps = HTMLAttributes<HTMLElement>;
|
|
575
|
-
/** Keyboard key primitive
|
|
716
|
+
/** Keyboard key primitive: `<kbd class="hl-kbd">`. */
|
|
576
717
|
declare const Kbd: react.ForwardRefExoticComponent<KbdProps & react.RefAttributes<HTMLElement>>;
|
|
577
718
|
|
|
719
|
+
/** Props for {@link Separator}. */
|
|
578
720
|
interface SeparatorProps extends HTMLAttributes<HTMLHRElement> {
|
|
579
721
|
orientation?: 'horizontal' | 'vertical';
|
|
580
|
-
/** Purely decorative
|
|
722
|
+
/** Purely decorative: removes it from the accessibility tree. */
|
|
581
723
|
decorative?: boolean;
|
|
582
724
|
}
|
|
583
|
-
/** Separator primitive
|
|
725
|
+
/** Separator primitive: `<hr class="hl-separator">`. */
|
|
584
726
|
declare const Separator: react.ForwardRefExoticComponent<SeparatorProps & react.RefAttributes<HTMLHRElement>>;
|
|
585
727
|
|
|
586
728
|
/** Join truthy class names into a single string. */
|
|
587
729
|
declare function cx(...classes: Array<string | false | null | undefined>): string;
|
|
588
730
|
|
|
589
|
-
export { Accordion, AccordionItem, type AccordionItemProps, type AccordionProps, Alert, type AlertProps, Avatar, AvatarGroup, type AvatarGroupProps, type AvatarProps, Badge, type BadgeProps, Breadcrumb, BreadcrumbItem, type BreadcrumbItemProps, type BreadcrumbProps, Button, type ButtonProps, Card, CardBody, CardDescription, CardFooter, CardHeader, type CardProps, type CardSectionProps, CardTitle, Checkbox, type CheckboxProps, Combobox, ComboboxInput, type ComboboxInputProps, ComboboxList, type ComboboxListProps, ComboboxOption, type ComboboxOptionProps, type ComboboxProps, Command, CommandEmpty, type CommandEmptyProps, CommandGroup, type CommandGroupProps, CommandInput, type CommandInputProps, CommandItem, type CommandItemProps, CommandList, type CommandListProps, type CommandProps, Disclosure, type DisclosureProps, Drawer, DrawerBody, DrawerFooter, DrawerHeader, type DrawerProps, type DrawerSectionProps, Dropdown, DropdownItem, type DropdownItemProps, DropdownMenu, type DropdownMenuProps, type DropdownProps, DropdownSeparator, type DropdownSeparatorProps, DropdownTrigger, type DropdownTriggerProps, Field, FieldError, FieldHelp, FieldLabel, type FieldLabelProps, type FieldProps, Fieldset, type FieldsetProps, Input, type InputProps, Kbd, type KbdProps, Menu, MenuItem, type MenuItemProps, type MenuProps, Modal, ModalBody, ModalFooter, ModalHeader, type ModalProps, type ModalSectionProps, Pagination, type PaginationProps, Popover, type PopoverProps, Progress, type ProgressProps, Radio, RadioGroup, type RadioGroupProps, type RadioProps, SegmentedControl, type SegmentedControlProps, type SegmentedOption, Select, type SelectOption, type SelectProps, Separator, type SeparatorProps, Skeleton, type SkeletonProps, SkipLink, type SkipLinkProps, Slider, type SliderProps, Spinner, type SpinnerProps, Switch, type SwitchProps, Tab, TabList, type TabListProps, TabPanel, type TabPanelProps, type TabProps, Tabs, type TabsProps, Textarea, type TextareaProps,
|
|
731
|
+
export { Accordion, AccordionItem, type AccordionItemProps, type AccordionProps, Alert, type AlertProps, Avatar, AvatarGroup, type AvatarGroupProps, type AvatarProps, Badge, type BadgeProps, Breadcrumb, BreadcrumbItem, type BreadcrumbItemProps, type BreadcrumbProps, Button, type ButtonProps, Card, CardBody, CardDescription, CardFooter, CardHeader, type CardProps, type CardSectionProps, CardTitle, Checkbox, type CheckboxProps, Combobox, ComboboxInput, type ComboboxInputProps, ComboboxList, type ComboboxListProps, ComboboxOption, type ComboboxOptionProps, type ComboboxProps, Command, CommandEmpty, type CommandEmptyProps, CommandGroup, type CommandGroupProps, CommandInput, type CommandInputProps, CommandItem, type CommandItemProps, CommandList, type CommandListProps, type CommandProps, Disclosure, type DisclosureProps, Drawer, DrawerBody, DrawerFooter, DrawerHeader, type DrawerProps, type DrawerSectionProps, Dropdown, DropdownItem, type DropdownItemProps, DropdownMenu, type DropdownMenuProps, type DropdownProps, DropdownSeparator, type DropdownSeparatorProps, DropdownTrigger, type DropdownTriggerProps, Field, FieldError, FieldHelp, FieldLabel, type FieldLabelProps, type FieldProps, Fieldset, type FieldsetProps, Input, type InputProps, Kbd, type KbdProps, Menu, MenuItem, type MenuItemProps, type MenuProps, Modal, ModalBody, ModalFooter, ModalHeader, type ModalProps, type ModalSectionProps, Pagination, type PaginationProps, Popover, type PopoverProps, Progress, type ProgressProps, Radio, RadioGroup, type RadioGroupProps, type RadioProps, SegmentedControl, type SegmentedControlProps, type SegmentedOption, Select, type SelectOption, type SelectProps, Separator, type SeparatorProps, Skeleton, type SkeletonProps, SkipLink, type SkipLinkProps, Slider, type SliderProps, Spinner, type SpinnerProps, Switch, type SwitchProps, Tab, TabList, type TabListProps, TabPanel, type TabPanelProps, type TabProps, Tabs, type TabsProps, Textarea, type TextareaProps, ToastRegion, type ToastRegionProps, Toc, type TocProps, Tooltip, type TooltipProps, cx, useAccordion, useDisclosureGroup, useDropdown, useEnhancer, useField, useModalGroup, useTabs, useToast, useTocEnhancer, useTooltip };
|