@ariakit/react-core 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/cjs/__chunks/{6MLKTO2T.cjs → 3ULNMLN7.cjs} +2 -2
  3. package/cjs/__chunks/{SL7OXEFQ.cjs → 4ULJINEP.cjs} +2 -2
  4. package/cjs/__chunks/{C47ZNHA6.cjs → 6UXB6PRK.cjs} +2 -2
  5. package/cjs/__chunks/{OAQQQ7LS.cjs → DMTOMUIM.cjs} +2 -2
  6. package/cjs/__chunks/{P2EILHN6.cjs → E4C2KZA5.cjs} +2 -2
  7. package/cjs/__chunks/{J63NAJOO.cjs → HCQYEOCO.cjs} +2 -2
  8. package/cjs/__chunks/{WRVKUV4V.cjs → HFISYIKE.cjs} +2 -2
  9. package/cjs/__chunks/{U33H4JTD.cjs → LJBXMHCD.cjs} +2 -2
  10. package/cjs/__chunks/{BPMML63M.cjs → NATUYKIW.cjs} +2 -2
  11. package/cjs/__chunks/{ZEASCR4B.cjs → QEG5AJH6.cjs} +2 -2
  12. package/cjs/__chunks/{B4KDFSF3.cjs → WBPFHFAX.cjs} +2 -2
  13. package/cjs/__chunks/{PHDU6PLM.cjs → XOHN6PER.cjs} +2 -2
  14. package/cjs/checkbox/checkbox.d.ts +12 -9
  15. package/cjs/collection/collection.d.ts +5 -1
  16. package/cjs/combobox/combobox-cancel.d.ts +14 -9
  17. package/cjs/combobox/combobox-disclosure.d.ts +14 -9
  18. package/cjs/combobox/combobox-group-label.d.ts +16 -11
  19. package/cjs/combobox/combobox-group.d.ts +16 -11
  20. package/cjs/combobox/combobox-item-value.d.ts +14 -10
  21. package/cjs/combobox/combobox-item.d.ts +45 -20
  22. package/cjs/combobox/combobox-list.d.ts +17 -10
  23. package/cjs/combobox/combobox-popover.cjs +5 -5
  24. package/cjs/combobox/combobox-popover.d.ts +8 -7
  25. package/cjs/combobox/combobox-provider.cjs +5 -5
  26. package/cjs/combobox/combobox-row.d.ts +21 -16
  27. package/cjs/combobox/combobox-separator.d.ts +15 -10
  28. package/cjs/combobox/combobox-store.cjs +5 -5
  29. package/cjs/combobox/combobox-store.d.ts +9 -4
  30. package/cjs/combobox/combobox.d.ts +55 -36
  31. package/cjs/composite/composite-overflow-store.cjs +4 -4
  32. package/cjs/composite/composite-overflow.cjs +5 -5
  33. package/cjs/dialog/dialog-backdrop.cjs +3 -3
  34. package/cjs/dialog/dialog-provider.cjs +3 -3
  35. package/cjs/dialog/dialog-store.cjs +3 -3
  36. package/cjs/dialog/dialog.cjs +4 -4
  37. package/cjs/disclosure/disclosure-content.d.ts +9 -4
  38. package/cjs/disclosure/disclosure-provider.cjs +2 -2
  39. package/cjs/disclosure/disclosure-store.cjs +2 -2
  40. package/cjs/disclosure/disclosure-store.d.ts +1 -2
  41. package/cjs/disclosure/disclosure.d.ts +13 -6
  42. package/cjs/form/form-checkbox.d.ts +5 -1
  43. package/cjs/form/form-description.d.ts +10 -3
  44. package/cjs/form/form-error.d.ts +10 -3
  45. package/cjs/form/form-field.d.ts +17 -9
  46. package/cjs/form/form-group-label.d.ts +7 -4
  47. package/cjs/form/form-group.d.ts +5 -2
  48. package/cjs/form/form-input.d.ts +9 -4
  49. package/cjs/form/form-label.d.ts +10 -3
  50. package/cjs/form/form-push.d.ts +5 -2
  51. package/cjs/form/form-radio-group.d.ts +5 -1
  52. package/cjs/form/form-radio.d.ts +5 -1
  53. package/cjs/form/form-remove.d.ts +5 -2
  54. package/cjs/form/form-reset.d.ts +6 -2
  55. package/cjs/form/form-store.d.ts +5 -1
  56. package/cjs/form/form-submit.d.ts +5 -2
  57. package/cjs/form/form.d.ts +5 -1
  58. package/cjs/hovercard/hovercard-anchor.d.ts +11 -5
  59. package/cjs/hovercard/hovercard-arrow.d.ts +13 -8
  60. package/cjs/hovercard/hovercard-description.d.ts +14 -9
  61. package/cjs/hovercard/hovercard-disclosure.d.ts +14 -8
  62. package/cjs/hovercard/hovercard-dismiss.d.ts +11 -6
  63. package/cjs/hovercard/hovercard-heading.d.ts +14 -9
  64. package/cjs/hovercard/hovercard-provider.cjs +5 -5
  65. package/cjs/hovercard/hovercard-store.cjs +5 -5
  66. package/cjs/hovercard/hovercard-store.d.ts +1 -0
  67. package/cjs/hovercard/hovercard.cjs +6 -6
  68. package/cjs/hovercard/hovercard.d.ts +11 -5
  69. package/cjs/menu/menu-button.cjs +3 -1
  70. package/cjs/menu/menu-provider.cjs +6 -6
  71. package/cjs/menu/menu-store.cjs +6 -6
  72. package/cjs/menu/menu-store.d.ts +6 -6
  73. package/cjs/menu/menu.cjs +6 -6
  74. package/cjs/popover/popover-provider.cjs +4 -4
  75. package/cjs/popover/popover-store.cjs +4 -4
  76. package/cjs/popover/popover.cjs +5 -5
  77. package/cjs/select/select-popover.cjs +5 -5
  78. package/cjs/select/select-provider.cjs +5 -5
  79. package/cjs/select/select-store.cjs +5 -5
  80. package/cjs/select/select-store.d.ts +2 -2
  81. package/cjs/tab/tab-panel.cjs +2 -2
  82. package/cjs/tooltip/tooltip-provider.cjs +6 -6
  83. package/cjs/tooltip/tooltip-store.cjs +6 -6
  84. package/cjs/tooltip/tooltip.cjs +6 -6
  85. package/cjs/tsconfig.build.tsbuildinfo +1 -1
  86. package/esm/__chunks/{YJPXO6F5.js → 34JEM52B.js} +1 -1
  87. package/esm/__chunks/{CJPLAYFB.js → 4RP654JS.js} +1 -1
  88. package/esm/__chunks/{RA2AAYOC.js → 4SB2BYFE.js} +1 -1
  89. package/esm/__chunks/{E6GADH6Y.js → A2ONBKVT.js} +2 -2
  90. package/esm/__chunks/{RVGVDX6B.js → GP4UGJIZ.js} +1 -1
  91. package/esm/__chunks/{XEZV3AK4.js → H2BG4QDT.js} +1 -1
  92. package/esm/__chunks/{HJHTMRDC.js → HZPJPDJY.js} +1 -1
  93. package/esm/__chunks/{6LKB3PXM.js → IFNQMENS.js} +1 -1
  94. package/esm/__chunks/{MA5WD4CD.js → UQFOL5I6.js} +1 -1
  95. package/esm/__chunks/{HCTAKPNS.js → UY3UQ4QI.js} +1 -1
  96. package/esm/__chunks/{R3N4R7UZ.js → V5EW3YHP.js} +1 -1
  97. package/esm/__chunks/{NRLOAE2I.js → W575AF63.js} +1 -1
  98. package/esm/checkbox/checkbox.d.ts +12 -9
  99. package/esm/collection/collection.d.ts +5 -1
  100. package/esm/combobox/combobox-cancel.d.ts +14 -9
  101. package/esm/combobox/combobox-disclosure.d.ts +14 -9
  102. package/esm/combobox/combobox-group-label.d.ts +16 -11
  103. package/esm/combobox/combobox-group.d.ts +16 -11
  104. package/esm/combobox/combobox-item-value.d.ts +14 -10
  105. package/esm/combobox/combobox-item.d.ts +45 -20
  106. package/esm/combobox/combobox-list.d.ts +17 -10
  107. package/esm/combobox/combobox-popover.d.ts +8 -7
  108. package/esm/combobox/combobox-popover.js +4 -4
  109. package/esm/combobox/combobox-provider.js +4 -4
  110. package/esm/combobox/combobox-row.d.ts +21 -16
  111. package/esm/combobox/combobox-separator.d.ts +15 -10
  112. package/esm/combobox/combobox-store.d.ts +9 -4
  113. package/esm/combobox/combobox-store.js +4 -4
  114. package/esm/combobox/combobox.d.ts +55 -36
  115. package/esm/composite/composite-overflow-store.js +3 -3
  116. package/esm/composite/composite-overflow.js +4 -4
  117. package/esm/dialog/dialog-backdrop.js +2 -2
  118. package/esm/dialog/dialog-provider.js +2 -2
  119. package/esm/dialog/dialog-store.js +2 -2
  120. package/esm/dialog/dialog.js +3 -3
  121. package/esm/disclosure/disclosure-content.d.ts +9 -4
  122. package/esm/disclosure/disclosure-provider.js +1 -1
  123. package/esm/disclosure/disclosure-store.d.ts +1 -2
  124. package/esm/disclosure/disclosure-store.js +1 -1
  125. package/esm/disclosure/disclosure.d.ts +13 -6
  126. package/esm/form/form-checkbox.d.ts +5 -1
  127. package/esm/form/form-description.d.ts +10 -3
  128. package/esm/form/form-error.d.ts +10 -3
  129. package/esm/form/form-field.d.ts +17 -9
  130. package/esm/form/form-group-label.d.ts +7 -4
  131. package/esm/form/form-group.d.ts +5 -2
  132. package/esm/form/form-input.d.ts +9 -4
  133. package/esm/form/form-label.d.ts +10 -3
  134. package/esm/form/form-push.d.ts +5 -2
  135. package/esm/form/form-radio-group.d.ts +5 -1
  136. package/esm/form/form-radio.d.ts +5 -1
  137. package/esm/form/form-remove.d.ts +5 -2
  138. package/esm/form/form-reset.d.ts +6 -2
  139. package/esm/form/form-store.d.ts +5 -1
  140. package/esm/form/form-submit.d.ts +5 -2
  141. package/esm/form/form.d.ts +5 -1
  142. package/esm/hovercard/hovercard-anchor.d.ts +11 -5
  143. package/esm/hovercard/hovercard-arrow.d.ts +13 -8
  144. package/esm/hovercard/hovercard-description.d.ts +14 -9
  145. package/esm/hovercard/hovercard-disclosure.d.ts +14 -8
  146. package/esm/hovercard/hovercard-dismiss.d.ts +11 -6
  147. package/esm/hovercard/hovercard-heading.d.ts +14 -9
  148. package/esm/hovercard/hovercard-provider.js +4 -4
  149. package/esm/hovercard/hovercard-store.d.ts +1 -0
  150. package/esm/hovercard/hovercard-store.js +4 -4
  151. package/esm/hovercard/hovercard.d.ts +11 -5
  152. package/esm/hovercard/hovercard.js +5 -5
  153. package/esm/menu/menu-button.js +3 -1
  154. package/esm/menu/menu-provider.js +5 -5
  155. package/esm/menu/menu-store.d.ts +6 -6
  156. package/esm/menu/menu-store.js +5 -5
  157. package/esm/menu/menu.js +5 -5
  158. package/esm/popover/popover-provider.js +3 -3
  159. package/esm/popover/popover-store.js +3 -3
  160. package/esm/popover/popover.js +4 -4
  161. package/esm/select/select-popover.js +4 -4
  162. package/esm/select/select-provider.js +4 -4
  163. package/esm/select/select-store.d.ts +2 -2
  164. package/esm/select/select-store.js +4 -4
  165. package/esm/tab/tab-panel.js +1 -1
  166. package/esm/tooltip/tooltip-provider.js +5 -5
  167. package/esm/tooltip/tooltip-store.js +5 -5
  168. package/esm/tooltip/tooltip.js +5 -5
  169. package/esm/tsconfig.build.tsbuildinfo +1 -1
  170. package/package.json +2 -2
@@ -22,7 +22,11 @@ export declare const useFormDescription: import("../utils/types.js").Hook<FormDe
22
22
  * @see https://ariakit.org/components/form
23
23
  * @example
24
24
  * ```jsx
25
- * const form = useFormStore({ defaultValues: { password: "" } });
25
+ * const form = useFormStore({
26
+ * defaultValues: {
27
+ * password: "",
28
+ * },
29
+ * });
26
30
  * <Form store={form}>
27
31
  * <FormLabel name={form.names.password}>Password</FormLabel>
28
32
  * <FormInput name={form.names.password} type="password" />
@@ -35,8 +39,11 @@ export declare const useFormDescription: import("../utils/types.js").Hook<FormDe
35
39
  export declare const FormDescription: import("../utils/types.js").Component<FormDescriptionOptions<"div">>;
36
40
  export interface FormDescriptionOptions<T extends As = "div"> extends CollectionItemOptions<T> {
37
41
  /**
38
- * Object returned by the `useFormStore` hook. If not provided, the parent
39
- * `Form` component's context will be used.
42
+ * Object returned by the
43
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
44
+ * provided, the closest [`Form`](https://ariakit.org/reference/form) or
45
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
46
+ * context will be used.
40
47
  */
41
48
  store?: FormStore;
42
49
  /**
@@ -30,7 +30,11 @@ export declare const useFormError: import("../utils/types.js").Hook<FormErrorOpt
30
30
  * @see https://ariakit.org/components/form
31
31
  * @example
32
32
  * ```jsx
33
- * const form = useFormStore({ defaultValues: { email: "" } });
33
+ * const form = useFormStore({
34
+ * defaultValues: {
35
+ * email: "",
36
+ * },
37
+ * });
34
38
  *
35
39
  * form.useValidate(() => {
36
40
  * if (!form.values.email) {
@@ -48,8 +52,11 @@ export declare const useFormError: import("../utils/types.js").Hook<FormErrorOpt
48
52
  export declare const FormError: import("../utils/types.js").Component<FormErrorOptions<"div">>;
49
53
  export interface FormErrorOptions<T extends As = "div"> extends CollectionItemOptions<T> {
50
54
  /**
51
- * Object returned by the `useFormStore` hook. If not provided, the parent
52
- * `Form` component's context will be used.
55
+ * Object returned by the
56
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
57
+ * provided, the closest [`Form`](https://ariakit.org/reference/form) or
58
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
59
+ * context will be used.
53
60
  */
54
61
  store?: FormStore;
55
62
  /**
@@ -30,21 +30,26 @@ import type { FormStore } from "./form-store.js";
30
30
  */
31
31
  export declare const useFormField: import("../utils/types.js").Hook<FormFieldOptions<"input">>;
32
32
  /**
33
- * Renders a form field. Unlike `FormInput`, this component doesn't
34
- * automatically pass the `value` and `onChange` props down to the underlying
35
- * element. This is so we can use it not only for native form elements but also
36
- * for custom components whose value is not controlled by the native `value` and
37
- * `onChange` props.
33
+ * Renders a form field. Unlike
34
+ * [`FormInput`](https://ariakit.org/reference/form-input), this component
35
+ * doesn't automatically pass the `value` and `onChange` props down to the
36
+ * underlying element. This is so we can use it not only for native form
37
+ * elements but also for custom components whose value is not controlled by the
38
+ * native `value` and `onChange` props.
38
39
  * @see https://ariakit.org/components/form
39
40
  * @example
40
41
  * ```jsx
41
- * const form = useFormStore({ defaultValues: { content: "" } });
42
+ * const form = useFormStore({
43
+ * defaultValues: {
44
+ * content: "",
45
+ * },
46
+ * });
47
+ *
42
48
  * const value = form.useValue(form.names.content);
43
49
  *
44
50
  * <Form store={form}>
45
51
  * <FormLabel name={form.names.content}>Content</FormLabel>
46
52
  * <FormField
47
- * {...props}
48
53
  * value={value}
49
54
  * onChange={(value) => form.setValue(form.names.content, value)}
50
55
  * render={<Editor />}
@@ -55,8 +60,11 @@ export declare const useFormField: import("../utils/types.js").Hook<FormFieldOpt
55
60
  export declare const FormField: import("../utils/types.js").Component<FormFieldOptions<"input">>;
56
61
  export interface FormFieldOptions<T extends As = "input"> extends CollectionItemOptions<T> {
57
62
  /**
58
- * Object returned by the `useFormStore` hook. If not provided, the parent
59
- * `Form` component's context will be used.
63
+ * Object returned by the
64
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
65
+ * provided, the closest [`Form`](https://ariakit.org/reference/form) or
66
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
67
+ * context will be used.
60
68
  */
61
69
  store?: FormStore;
62
70
  /**
@@ -16,8 +16,8 @@ import type { FormStore } from "./form-store.js";
16
16
  export declare const useFormGroupLabel: import("../utils/types.js").Hook<FormGroupLabelOptions<"div">>;
17
17
  /**
18
18
  * Renders a label in a form group. This component must be wrapped with
19
- * `FormGroup` so the `aria-labelledby` prop is properly set on the form group
20
- * element.
19
+ * [`FormGroup`](https://ariakit.org/reference/form-group) so the
20
+ * `aria-labelledby` prop is properly set on the form group element.
21
21
  * @see https://ariakit.org/components/form
22
22
  * @example
23
23
  * ```jsx
@@ -41,8 +41,11 @@ export declare const useFormGroupLabel: import("../utils/types.js").Hook<FormGro
41
41
  export declare const FormGroupLabel: import("../utils/types.js").Component<FormGroupLabelOptions<"div">>;
42
42
  export interface FormGroupLabelOptions<T extends As = "div"> extends GroupLabelOptions<T> {
43
43
  /**
44
- * Object returned by the `useFormStore` hook. If not provided, the parent
45
- * `Form` component's context will be used.
44
+ * Object returned by the
45
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
46
+ * provided, the closest [`Form`](https://ariakit.org/reference/form) or
47
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
48
+ * context will be used.
46
49
  */
47
50
  store?: FormStore;
48
51
  }
@@ -41,8 +41,11 @@ export declare const useFormGroup: import("../utils/types.js").Hook<FormGroupOpt
41
41
  export declare const FormGroup: import("../utils/types.js").Component<FormGroupOptions<"div">>;
42
42
  export interface FormGroupOptions<T extends As = "div"> extends GroupOptions<T> {
43
43
  /**
44
- * Object returned by the `useFormStore` hook. If not provided, the parent
45
- * `Form` component's context will be used.
44
+ * Object returned by the
45
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
46
+ * provided, the closest [`Form`](https://ariakit.org/reference/form) or
47
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
48
+ * context will be used.
46
49
  */
47
50
  store?: FormStore;
48
51
  }
@@ -18,13 +18,18 @@ import type { FormFieldOptions } from "./form-field.js";
18
18
  */
19
19
  export declare const useFormInput: import("../utils/types.js").Hook<FormInputOptions<"input">>;
20
20
  /**
21
- * Renders a form input. Unlike `FormField`, this component passes the `value`
22
- * and `onChange` props down to the underlying element that can be a native
23
- * input, select or textarea elements.
21
+ * Renders a form input. Unlike
22
+ * [`FormField`](https://ariakit.org/reference/form-field), this component
23
+ * passes the `value` and `onChange` props down to the underlying element that
24
+ * can be a native input, select or textarea elements.
24
25
  * @see https://ariakit.org/components/form
25
26
  * @example
26
27
  * ```jsx
27
- * const form = useFormStore({ defaultValues: { email: "" } });
28
+ * const form = useFormStore({
29
+ * defaultValues: {
30
+ * email: "",
31
+ * },
32
+ * });
28
33
  * <Form store={form}>
29
34
  * <FormLabel name={form.names.email}>Email</FormLabel>
30
35
  * <FormInput name={form.names.email} />
@@ -29,7 +29,11 @@ export declare const useFormLabel: import("../utils/types.js").Hook<FormLabelOpt
29
29
  * @see https://ariakit.org/components/form
30
30
  * @example
31
31
  * ```jsx
32
- * const form = useFormStore({ defaultValues: { email: "" } });
32
+ * const form = useFormStore({
33
+ * defaultValues: {
34
+ * email: "",
35
+ * },
36
+ * });
33
37
  * <Form store={form}>
34
38
  * <FormLabel name={form.names.email}>Email</Role>
35
39
  * <FormInput name={form.names.email} />
@@ -39,8 +43,11 @@ export declare const useFormLabel: import("../utils/types.js").Hook<FormLabelOpt
39
43
  export declare const FormLabel: import("../utils/types.js").Component<FormLabelOptions<"label">>;
40
44
  export interface FormLabelOptions<T extends As = "label"> extends CollectionItemOptions<T> {
41
45
  /**
42
- * Object returned by the `useFormStore` hook. If not provided, the parent
43
- * `Form` component's context will be used.
46
+ * Object returned by the
47
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
48
+ * provided, the closest [`Form`](https://ariakit.org/reference/form) or
49
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
50
+ * context will be used.
44
51
  */
45
52
  store?: FormStore;
46
53
  /**
@@ -55,8 +55,11 @@ export declare const useFormPush: import("../utils/types.js").Hook<FormPushOptio
55
55
  export declare const FormPush: import("../utils/types.js").Component<FormPushOptions<"button">>;
56
56
  export interface FormPushOptions<T extends As = "button"> extends ButtonOptions<T>, CollectionItemOptions<T> {
57
57
  /**
58
- * Object returned by the `useFormStore` hook. If not provided, the parent
59
- * `Form` component's context will be used.
58
+ * Object returned by the
59
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
60
+ * provided, the closest [`Form`](https://ariakit.org/reference/form) or
61
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
62
+ * context will be used.
60
63
  */
61
64
  store?: FormStore;
62
65
  /**
@@ -23,7 +23,11 @@ export declare const useFormRadioGroup: import("../utils/types.js").Hook<FormRad
23
23
  * @see https://ariakit.org/components/form
24
24
  * @example
25
25
  * ```jsx
26
- * const form = useFormStore({ defaultValues: { color: "red" } });
26
+ * const form = useFormStore({
27
+ * defaultValues: {
28
+ * color: "red",
29
+ * },
30
+ * });
27
31
  * <Form store={form}>
28
32
  * <FormRadioGroup>
29
33
  * <FormGroupLabel>Favorite color</FormGroupLabel>
@@ -26,7 +26,11 @@ export declare const useFormRadio: import("../utils/types.js").Hook<FormRadioOpt
26
26
  * @see https://ariakit.org/components/form
27
27
  * @example
28
28
  * ```jsx
29
- * const form = useFormStore({ defaultValues: { char: "a" } });
29
+ * const form = useFormStore({
30
+ * defaultValues: {
31
+ * char: "a",
32
+ * },
33
+ * });
30
34
  * <Form store={form}>
31
35
  * <FormRadioGroup>
32
36
  * <FormGroupLabel>Favorite character</FormGroupLabel>
@@ -54,8 +54,11 @@ export declare const useFormRemove: import("../utils/types.js").Hook<FormRemoveO
54
54
  export declare const FormRemove: import("../utils/types.js").Component<FormRemoveOptions<"button">>;
55
55
  export interface FormRemoveOptions<T extends As = "button"> extends ButtonOptions<T> {
56
56
  /**
57
- * Object returned by the `useFormStore` hook. If not provided, the parent
58
- * `Form` component's context will be used.
57
+ * Object returned by the
58
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
59
+ * provided, the closest [`Form`](https://ariakit.org/reference/form) or
60
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
61
+ * context will be used.
59
62
  */
60
63
  store?: FormStore;
61
64
  /**
@@ -20,6 +20,7 @@ export declare const useFormReset: import("../utils/types.js").Hook<FormResetOpt
20
20
  * @example
21
21
  * ```jsx
22
22
  * const form = useFormStore();
23
+ *
23
24
  * <Form store={form}>
24
25
  * <FormReset>Reset</FormReset>
25
26
  * </Form>
@@ -28,8 +29,11 @@ export declare const useFormReset: import("../utils/types.js").Hook<FormResetOpt
28
29
  export declare const FormReset: import("../utils/types.js").Component<FormResetOptions<"button">>;
29
30
  export interface FormResetOptions<T extends As = "button"> extends ButtonOptions<T> {
30
31
  /**
31
- * Object returned by the `useFormStore` hook. If not provided, the parent
32
- * `Form` component's context will be used.
32
+ * Object returned by the
33
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
34
+ * provided, the closest [`Form`](https://ariakit.org/reference/form) or
35
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
36
+ * context will be used.
33
37
  */
34
38
  store?: FormStore;
35
39
  }
@@ -14,7 +14,11 @@ export declare function useFormStoreProps<T extends Omit<FormStore, "useValue" |
14
14
  * Creates a form store.
15
15
  * @example
16
16
  * ```jsx
17
- * const form = useFormStore({ defaultValues: { email: "" } });
17
+ * const form = useFormStore({
18
+ * defaultValues: {
19
+ * email: "",
20
+ * },
21
+ * });
18
22
  * <Form store={form}>
19
23
  * <FormLabel name={form.names.email}>Email</FormLabel>
20
24
  * <FormInput name={form.names.email} />
@@ -28,8 +28,11 @@ export declare const useFormSubmit: import("../utils/types.js").Hook<FormSubmitO
28
28
  export declare const FormSubmit: import("../utils/types.js").Component<FormSubmitOptions<"button">>;
29
29
  export interface FormSubmitOptions<T extends As = "button"> extends ButtonOptions<T> {
30
30
  /**
31
- * Object returned by the `useFormStore` hook. If not provided, the parent
32
- * `Form` component's context will be used.
31
+ * Object returned by the
32
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
33
+ * provided, the closest [`Form`](https://ariakit.org/reference/form) or
34
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) components'
35
+ * context will be used.
33
36
  */
34
37
  store?: FormStore;
35
38
  /**
@@ -26,7 +26,11 @@ export declare const useForm: import("../utils/types.js").Hook<FormOptions<"form
26
26
  export declare const Form: import("../utils/types.js").Component<FormOptions<"form">>;
27
27
  export interface FormOptions<T extends As = "form"> extends Options<T> {
28
28
  /**
29
- * Object returned by the `useFormStore` hook.
29
+ * Object returned by the
30
+ * [`useFormStore`](https://ariakit.org/reference/use-form-store) hook. If not
31
+ * provided, the closest
32
+ * [`FormProvider`](https://ariakit.org/reference/form-provider) component's
33
+ * context will be used.
30
34
  */
31
35
  store?: FormStore;
32
36
  /**
@@ -16,19 +16,25 @@ import type { HovercardStore } from "./hovercard-store.js";
16
16
  */
17
17
  export declare const useHovercardAnchor: import("../utils/types.js").Hook<HovercardAnchorOptions<"a">>;
18
18
  /**
19
- * Renders an anchor element that will open a popover (`Hovercard`) on hover.
19
+ * Renders an anchor element that will open a
20
+ * [`Hovercard`](https://ariakit.org/reference/hovercard) popup on hover.
20
21
  * @see https://ariakit.org/components/hovercard
21
22
  * @example
22
23
  * ```jsx
23
- * const hovercard = useHovercardStore();
24
- * <HovercardAnchor store={hovercard}>@username</HovercardAnchor>
25
- * <Hovercard store={hovercard}>Details</Hovercard>
24
+ * <HovercardProvider>
25
+ * <HovercardAnchor>@username</HovercardAnchor>
26
+ * <Hovercard>Details</Hovercard>
27
+ * </HovercardProvider>
26
28
  * ```
27
29
  */
28
30
  export declare const HovercardAnchor: import("../utils/types.js").Component<HovercardAnchorOptions<"a">>;
29
31
  export interface HovercardAnchorOptions<T extends As = "a"> extends FocusableOptions<T> {
30
32
  /**
31
- * Object returned by the `useHovercardStore` hook.
33
+ * Object returned by the
34
+ * [`useHovercardStore`](https://ariakit.org/reference/use-hovercard-store)
35
+ * hook. If not provided, the closest
36
+ * [`HovercardProvider`](https://ariakit.org/reference/hovercard-provider)
37
+ * component's context will be used.
32
38
  */
33
39
  store?: HovercardStore;
34
40
  /**
@@ -20,19 +20,24 @@ export declare const useHovercardArrow: import("../utils/types.js").Hook<Hoverca
20
20
  * @see https://ariakit.org/components/hovercard
21
21
  * @example
22
22
  * ```jsx
23
- * const hovercard = useHovercardStore();
24
- * <HovercardAnchor store={hovercard}>@username</HovercardAnchor>
25
- * <Hovercard store={hovercard}>
26
- * <HovercardArrow />
27
- * Details
28
- * </Hovercard>
23
+ * <HovercardProvider>
24
+ * <HovercardAnchor>@username</HovercardAnchor>
25
+ * <Hovercard>
26
+ * <HovercardArrow />
27
+ * Details
28
+ * </Hovercard>
29
+ * </HovercardProvider>
29
30
  * ```
30
31
  */
31
32
  export declare const HovercardArrow: import("../utils/types.js").Component<HovercardArrowOptions<"div">>;
32
33
  export interface HovercardArrowOptions<T extends As = "div"> extends PopoverArrowOptions<T> {
33
34
  /**
34
- * Object returned by the `useHovercardStore` hook. If not provided, the
35
- * parent `Hovercard` component's context will be used.
35
+ * Object returned by the
36
+ * [`useHovercardStore`](https://ariakit.org/reference/use-hovercard-store)
37
+ * hook. If not provided, the closest
38
+ * [`Hovercard`](https://ariakit.org/reference/hovercard) or
39
+ * [`HovercardProvider`](https://ariakit.org/reference/hovercard-provider)
40
+ * components' context will be used.
36
41
  */
37
42
  store?: HovercardStore;
38
43
  }
@@ -15,23 +15,28 @@ import type { HovercardStore } from "./hovercard-store.js";
15
15
  */
16
16
  export declare const useHovercardDescription: import("../utils/types.js").Hook<HovercardDescriptionOptions<"p">>;
17
17
  /**
18
- * Renders a description in a hovercard. This component must be wrapped with
19
- * `Hovercard` so the `aria-describedby` prop is properly set on the hovercard
20
- * element.
18
+ * Renders a description in a hovercard. This component must be wrapped within
19
+ * [`Hovercard`](https://ariakit.org/reference/hovercard) so the
20
+ * `aria-describedby` prop is properly set on the hovercard element.
21
21
  * @see https://ariakit.org/components/hovercard
22
22
  * @example
23
23
  * ```jsx
24
- * const hovercard = useHovercardStore();
25
- * <Hovercard store={hovercard}>
26
- * <HovercardDescription>Description</HovercardDescription>
27
- * </Hovercard>
24
+ * <HovercardProvider>
25
+ * <Hovercard>
26
+ * <HovercardDescription>Description</HovercardDescription>
27
+ * </Hovercard>
28
+ * </HovercardProvider>
28
29
  * ```
29
30
  */
30
31
  export declare const HovercardDescription: import("../utils/types.js").Component<HovercardDescriptionOptions<"p">>;
31
32
  export interface HovercardDescriptionOptions<T extends As = "p"> extends PopoverDescriptionOptions<T> {
32
33
  /**
33
- * Object returned by the `useHovercardStore` hook. If not provided, the
34
- * parent `Hovercard` component's context will be used.
34
+ * Object returned by the
35
+ * [`useHovercardStore`](https://ariakit.org/reference/use-hovercard-store)
36
+ * hook. If not provided, the closest
37
+ * [`Hovercard`](https://ariakit.org/reference/hovercard) or
38
+ * [`HovercardProvider`](https://ariakit.org/reference/hovercard-provider)
39
+ * components' context will be used.
35
40
  */
36
41
  store?: HovercardStore;
37
42
  }
@@ -15,22 +15,28 @@ import type { HovercardStore } from "./hovercard-store.js";
15
15
  */
16
16
  export declare const useHovercardDisclosure: import("../utils/types.js").Hook<HovercardDisclosureOptions<"button">>;
17
17
  /**
18
- * Renders a hidden disclosure button that will be visible when the hovercard
19
- * anchor element (`HovercardAnchor`) receives keyboard focus. The user can then
20
- * navigate to the button to open the hovercard when using the keyboard.
18
+ * Renders a hidden disclosure button that will be visible when the
19
+ * [`HovercardAnchor`](https://ariakit.org/reference/hovercard-anchor) receives
20
+ * keyboard focus. The user can then navigate to the button to open the
21
+ * hovercard when using the keyboard.
21
22
  * @see https://ariakit.org/components/hovercard
22
23
  * @example
23
24
  * ```jsx
24
- * const hovercard = useHovercardStore();
25
- * <HovercardAnchor store={hovercard}>@username</HovercardAnchor>
26
- * <HovercardDisclosure store={hovercard} />
27
- * <Hovercard store={hovercard}>Details</Hovercard>
25
+ * <HovercardProvider>
26
+ * <HovercardAnchor>@username</HovercardAnchor>
27
+ * <HovercardDisclosure />
28
+ * <Hovercard>Details</Hovercard>
29
+ * </HovercardProvider>
28
30
  * ```
29
31
  */
30
32
  export declare const HovercardDisclosure: import("../utils/types.js").Component<HovercardDisclosureOptions<"button">>;
31
33
  export interface HovercardDisclosureOptions<T extends As = "button"> extends DialogDisclosureOptions<T> {
32
34
  /**
33
- * Object returned by the `useHovercardStore` hook.
35
+ * Object returned by the
36
+ * [`useHovercardStore`](https://ariakit.org/reference/use-hovercard-store)
37
+ * hook. If not provided, the closest
38
+ * [`HovercardProvider`](https://ariakit.org/reference/hovercard-provider)
39
+ * component's context will be used.
34
40
  */
35
41
  store?: HovercardStore;
36
42
  }
@@ -19,17 +19,22 @@ export declare const useHovercardDismiss: import("../utils/types.js").Hook<Hover
19
19
  * @see https://ariakit.org/components/hovercard
20
20
  * @example
21
21
  * ```jsx
22
- * const hovercard = useHovercardStore();
23
- * <Hovercard store={hovercard}>
24
- * <HovercardDismiss />
25
- * </Hovercard>
22
+ * <HovercardProvider>
23
+ * <Hovercard>
24
+ * <HovercardDismiss />
25
+ * </Hovercard>
26
+ * </HovercardProvider>
26
27
  * ```
27
28
  */
28
29
  export declare const HovercardDismiss: import("../utils/types.js").Component<HovercardDismissOptions<"button">>;
29
30
  export interface HovercardDismissOptions<T extends As = "button"> extends PopoverDismissOptions<T> {
30
31
  /**
31
- * Object returned by the `useHovercardStore` hook. If not provided, the
32
- * parent `Hovercard` component's context will be used.
32
+ * Object returned by the
33
+ * [`useHovercardStore`](https://ariakit.org/reference/use-hovercard-store)
34
+ * hook. If not provided, the closest
35
+ * [`Hovercard`](https://ariakit.org/reference/hovercard) or
36
+ * [`HovercardProvider`](https://ariakit.org/reference/hovercard-provider)
37
+ * components' context will be used.
33
38
  */
34
39
  store?: HovercardStore;
35
40
  }
@@ -15,23 +15,28 @@ import type { HovercardStore } from "./hovercard-store.js";
15
15
  */
16
16
  export declare const useHovercardHeading: import("../utils/types.js").Hook<HovercardHeadingOptions<"h1">>;
17
17
  /**
18
- * Renders a heading in a hovercard. This component must be wrapped with
19
- * `Hovercard` so the `aria-labelledby` prop is properly set on the hovercard
20
- * element.
18
+ * Renders a heading in a hovercard. This component must be wrapped within
19
+ * [`Hovercard`](https://ariakit.org/reference/hovercard) so the
20
+ * `aria-labelledby` prop is properly set on the hovercard element.
21
21
  * @see https://ariakit.org/components/hovercard
22
22
  * @example
23
23
  * ```jsx
24
- * const hovercard = useHovercardStore();
25
- * <Hovercard store={hovercard}>
26
- * <HovercardHeading>Heading</HovercardHeading>
27
- * </Hovercard>
24
+ * <HovercardProvider>
25
+ * <Hovercard>
26
+ * <HovercardHeading>Heading</HovercardHeading>
27
+ * </Hovercard>
28
+ * </HovercardProvider>
28
29
  * ```
29
30
  */
30
31
  export declare const HovercardHeading: import("../utils/types.js").Component<HovercardHeadingOptions<"h1">>;
31
32
  export interface HovercardHeadingOptions<T extends As = "h1"> extends PopoverHeadingOptions<T> {
32
33
  /**
33
- * Object returned by the `useHovercardStore` hook. If not provided, the
34
- * parent `Hovercard` component's context will be used.
34
+ * Object returned by the
35
+ * [`useHovercardStore`](https://ariakit.org/reference/use-hovercard-store)
36
+ * hook. If not provided, the closest
37
+ * [`Hovercard`](https://ariakit.org/reference/hovercard) or
38
+ * [`HovercardProvider`](https://ariakit.org/reference/hovercard-provider)
39
+ * components' context will be used.
35
40
  */
36
41
  store?: HovercardStore;
37
42
  }
@@ -7,10 +7,10 @@ require('../__chunks/A2NMYLCG.cjs');
7
7
  require('../__chunks/Z5PUIG6A.cjs');
8
8
 
9
9
 
10
- var _C47ZNHA6cjs = require('../__chunks/C47ZNHA6.cjs');
11
- require('../__chunks/P2EILHN6.cjs');
12
- require('../__chunks/BPMML63M.cjs');
13
- require('../__chunks/6MLKTO2T.cjs');
10
+ var _6UXB6PRKcjs = require('../__chunks/6UXB6PRK.cjs');
11
+ require('../__chunks/E4C2KZA5.cjs');
12
+ require('../__chunks/NATUYKIW.cjs');
13
+ require('../__chunks/3ULNMLN7.cjs');
14
14
  require('../__chunks/I63PYP2U.cjs');
15
15
  require('../__chunks/5WLTMVVQ.cjs');
16
16
  require('../__chunks/7WUTS26Y.cjs');
@@ -19,7 +19,7 @@ require('../__chunks/72I2GWXF.cjs');
19
19
  // src/hovercard/hovercard-provider.tsx
20
20
  var _jsxruntime = require('react/jsx-runtime');
21
21
  function HovercardProvider(props = {}) {
22
- const store = _C47ZNHA6cjs.useHovercardStore.call(void 0, props);
22
+ const store = _6UXB6PRKcjs.useHovercardStore.call(void 0, props);
23
23
  return /* @__PURE__ */ _jsxruntime.jsx.call(void 0, _Q6W7IWNJcjs.HovercardContextProvider, { value: store, children: props.children });
24
24
  }
25
25
 
@@ -1,10 +1,10 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _C47ZNHA6cjs = require('../__chunks/C47ZNHA6.cjs');
5
- require('../__chunks/P2EILHN6.cjs');
6
- require('../__chunks/BPMML63M.cjs');
7
- require('../__chunks/6MLKTO2T.cjs');
4
+ var _6UXB6PRKcjs = require('../__chunks/6UXB6PRK.cjs');
5
+ require('../__chunks/E4C2KZA5.cjs');
6
+ require('../__chunks/NATUYKIW.cjs');
7
+ require('../__chunks/3ULNMLN7.cjs');
8
8
  require('../__chunks/I63PYP2U.cjs');
9
9
  require('../__chunks/5WLTMVVQ.cjs');
10
10
  require('../__chunks/7WUTS26Y.cjs');
@@ -12,4 +12,4 @@ require('../__chunks/72I2GWXF.cjs');
12
12
 
13
13
 
14
14
 
15
- exports.useHovercardStore = _C47ZNHA6cjs.useHovercardStore; exports.useHovercardStoreProps = _C47ZNHA6cjs.useHovercardStoreProps;
15
+ exports.useHovercardStore = _6UXB6PRKcjs.useHovercardStore; exports.useHovercardStoreProps = _6UXB6PRKcjs.useHovercardStoreProps;
@@ -8,6 +8,7 @@ export declare function useHovercardStoreProps<T extends Core.HovercardStore>(st
8
8
  * @example
9
9
  * ```jsx
10
10
  * const hovercard = useHovercardStore({ placement: "top" });
11
+ *
11
12
  * <HovercardAnchor store={hovercard}>@username</HovercardAnchor>
12
13
  * <Hovercard store={hovercard}>Details</Hovercard>
13
14
  * ```
@@ -1,11 +1,11 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _B4KDFSF3cjs = require('../__chunks/B4KDFSF3.cjs');
4
+ var _WBPFHFAXcjs = require('../__chunks/WBPFHFAX.cjs');
5
5
  require('../__chunks/OLGMV24U.cjs');
6
- require('../__chunks/PHDU6PLM.cjs');
7
- require('../__chunks/ZEASCR4B.cjs');
8
- require('../__chunks/J63NAJOO.cjs');
6
+ require('../__chunks/XOHN6PER.cjs');
7
+ require('../__chunks/QEG5AJH6.cjs');
8
+ require('../__chunks/HCQYEOCO.cjs');
9
9
  require('../__chunks/6BAHKJ5K.cjs');
10
10
  require('../__chunks/DPLHWKRP.cjs');
11
11
  require('../__chunks/W32FX7DM.cjs');
@@ -35,7 +35,7 @@ require('../__chunks/BFLDQF3L.cjs');
35
35
  require('../__chunks/LHHW5ZQP.cjs');
36
36
  require('../__chunks/KSFAO77E.cjs');
37
37
  require('../__chunks/Z5PUIG6A.cjs');
38
- require('../__chunks/6MLKTO2T.cjs');
38
+ require('../__chunks/3ULNMLN7.cjs');
39
39
  require('../__chunks/I63PYP2U.cjs');
40
40
  require('../__chunks/5WLTMVVQ.cjs');
41
41
  require('../__chunks/7WUTS26Y.cjs');
@@ -43,4 +43,4 @@ require('../__chunks/72I2GWXF.cjs');
43
43
 
44
44
 
45
45
 
46
- exports.Hovercard = _B4KDFSF3cjs.Hovercard; exports.useHovercard = _B4KDFSF3cjs.useHovercard;
46
+ exports.Hovercard = _WBPFHFAXcjs.Hovercard; exports.useHovercard = _WBPFHFAXcjs.useHovercard;