@allxsmith/bestax-bulma 5.34.3 → 5.35.0

package/dist/types/components/Loading.d.ts

@@ -16,7 +16,12 @@ export type LoadingColor = 'primary' | 'link' | 'info' | 'success' | 'warning' |
 export interface LoadingProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'color'>, Omit<BulmaClassesProps, 'color' | 'backgroundColor' | 'size' | 'overlay'> {
     /** Whether the loading overlay is visible. */
     active?: boolean;
-    /** Cover the entire viewport. */
+    /**
+     * Cover the entire viewport. A full-page loading also takes its turn with
+     * Modal and Sidebar for Escape: while it's the topmost open overlay, the
+     * Modal or Sidebar under it doesn't answer Escape or hold Tab, whether or
+     * not the loading can be cancelled.
+     */
     isFullPage?: boolean;
     /** Size of the loading spinner. */
     size?: 'small' | 'medium' | 'large';
@@ -24,8 +29,13 @@ export interface LoadingProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
     color?: LoadingColor;
     /**
      * Show a cancel button and allow closing, by a click on the overlay or by
-     * Escape. An Escape a popup on the page closed on, by calling
-     * `preventDefault()`, doesn't cancel.
+     * Escape. With `isFullPage`, the loading is an overlay like Modal and
+     * Sidebar: only the topmost open overlay answers Escape, so a full-page
+     * loading shown over a Modal cancels first, and the Modal closes on the
+     * next Escape. Without it, Escape cancels once no Modal, Dialog, Sidebar or
+     * full-page Loading is open. Either way it marks the Escape it cancels on as
+     * used with `preventDefault()`. An Escape a popup on the page closed on, by
+     * calling `preventDefault()`, doesn't cancel.
      */
     canCancel?: boolean;
     /** Callback when cancel is triggered. */

package/dist/types/components/Menu.d.ts

@@ -56,7 +56,16 @@ export interface MenuItemOwnProps extends BulmaClassesProps {
     className?: string;
     /** Item content and optional nested MenuList. */
     children: React.ReactNode;
-    /** Highlight item as active. */
+    /**
+     * Marks the item as the current one. It adds Bulma's `is-active` class, and
+     * `aria-current="page"` on the element `as` renders, so assistive tech can
+     * tell which item is current too. An `aria-current` you pass wins, even
+     * `undefined`: use it to say something else (`"location"` for a section of
+     * one page, say), or `aria-current={false}` to turn it off. A menu should
+     * mark one page, so when the section above the current page is `active` too,
+     * give it `aria-current="location"`, and give an `active` item that isn't
+     * navigation, such as an `as="button"` filter, `aria-current={false}`.
+     */
     active?: boolean;
     /** Inline styles for the wrapping `<li>`. */
     style?: React.CSSProperties;
@@ -91,6 +100,10 @@ export type MenuItemProps<T extends React.ElementType = 'a'> = MenuItemOwnProps
 /**
  * MenuItem supports `as` prop for custom link components, e.g., react-router-dom Link.
  *
+ * Give each item an `href`, a router link through `as`, or `as="button"`, so
+ * the keyboard can reach it: an `<a>` with no `href` isn't a link, and Tab
+ * skips it.
+ *
  * @function
  * @param {MenuItemProps} props - Props for the MenuItem component.
  * @param {React.Ref} ref - Forwarded ref to the inner element `as` renders.

package/dist/types/components/Modal.d.ts

@@ -30,10 +30,13 @@ export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     children?: React.ReactNode;
     /**
      * Close the modal when the Escape key is pressed (calls `onClose`). Only the
-     * topmost open modal responds, so Escape closes one layer at a time. A popup
-     * inside it, such as a Dropdown's menu or a date picker's calendar, takes
-     * its own Escape first, and so does content that calls `preventDefault()`
-     * on it.
+     * topmost open overlay responds, whichever Modal, Dialog, Sidebar or
+     * full-page Loading opened last, so Escape closes one layer at a time. The
+     * modal marks the Escape it closes on as used with `preventDefault()`, and
+     * a Toast waits until no overlay is open. Turned off, a modal on top still
+     * keeps Escape from the layers under it. A popup inside it, such as a
+     * Dropdown's menu or a date picker's calendar, takes its own Escape first,
+     * and so does content that calls `preventDefault()` on it.
      * @defaultValue true
      */
     closeOnEscape?: boolean;

package/dist/types/components/Sidebar.d.ts

@@ -25,9 +25,14 @@ export interface SidebarProps extends Omit<React.HTMLAttributes<HTMLElement>, 'c
     /** Close sidebar when overlay is clicked. Default: true. */
     overlayClose?: boolean;
     /**
-     * Close sidebar on Escape key. A popup inside it, such as a Dropdown's menu
-     * or a date picker's calendar, takes its own Escape first, and so does
-     * content that calls `preventDefault()` on it. Default: true.
+     * Close sidebar on Escape key. Only the topmost open overlay responds,
+     * whichever Modal, Dialog, Sidebar or full-page Loading opened last, so
+     * Escape closes one layer at a time. The sidebar marks the Escape it closes
+     * on as used with `preventDefault()`, and a Toast waits until no overlay is
+     * open. Turned off, a sidebar on top still keeps Escape from the layers
+     * under it. A popup inside it, such as a Dropdown's menu or a date picker's
+     * calendar, takes its own Escape first, and so does content that calls
+     * `preventDefault()` on it. Default: true.
      */
     escapeClose?: boolean;
     /** Allow closing the sidebar. Default: true. */

package/dist/types/components/Steps.d.ts

@@ -8,7 +8,11 @@ export type StepsColor = 'primary' | 'link' | 'info' | 'success' | 'warning' | '
  * Props for individual Step items.
  */
 export interface StepItemProps {
-    /** Step label/title */
+    /**
+     * Step label/title. On a `clickable` step it's rendered inside the step's
+     * `<button>`, so it has to be phrasing content, like text, a `<span>` or an
+     * icon, with no link, button or other control in it.
+     */
     label?: React.ReactNode;
     /** Icon for the step marker */
     icon?: React.ReactNode;
@@ -17,7 +21,11 @@ export interface StepItemProps {
      * @defaultValue '✓'
      */
     completedIcon?: React.ReactNode;
-    /** Whether this step is clickable */
+    /**
+     * Whether this step is clickable. A clickable step puts its marker and
+     * label in a `<button type="button">` inside its list item, which calls
+     * `onStepClick`, and the current step's `aria-current` goes on that button.
+     */
     clickable?: boolean;
     /** Additional CSS classes. */
     className?: string;
@@ -44,7 +52,11 @@ export interface StepsProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     rounded?: boolean;
     /** Vertical layout. */
     vertical?: boolean;
-    /** Position of labels. */
+    /**
+     * Position of labels. `right` and `left` mean the end and the start of the
+     * line, so in a right-to-left page `right` puts each label to the left of
+     * its marker, and `left` to the right.
+     */
     labelPosition?: 'bottom' | 'right' | 'left';
     /** Mobile display mode. */
     mobileMode?: 'minimal' | 'compact' | 'right';
@@ -75,11 +87,21 @@ export interface StepProps extends Omit<React.LiHTMLAttributes<HTMLLIElement>, '
     isActive?: boolean;
     /** Whether this step is completed */
     isCompleted?: boolean;
-    /** Step label/title */
+    /**
+     * Step label/title, or pass it as `children`. On a `clickable` step it's
+     * rendered inside the step's `<button>`, so it has to be phrasing content,
+     * like text, a `<span>` or an icon, with no link, button or other control
+     * in it.
+     */
     label?: React.ReactNode;
     /** Icon for the step marker */
     icon?: React.ReactNode;
-    /** Whether this step is clickable */
+    /**
+     * Whether this step is clickable. A clickable step puts its marker and
+     * label in a `<button type="button">` inside the `<li>`, which calls
+     * `onClick`, and `aria-current` goes on that button. The `<li>` keeps the
+     * rest of the props.
+     */
     clickable?: boolean;
     /** Click handler */
     onClick?: () => void;

package/dist/types/components/Toast.d.ts

@@ -35,8 +35,11 @@ export interface ToastProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     /** Pause auto-close timer on hover. Default: false. */
     pauseOnHover?: boolean;
     /**
-     * Whether the toast can be dismissed with Escape. An Escape a popup on the
-     * page closed on, by calling `preventDefault()`, leaves it up. Default: true.
+     * Whether the toast can be dismissed with Escape. While a Modal, Dialog,
+     * Sidebar or full-page Loading is open, Escape goes to that overlay and the
+     * toast stays up, so Escape dismisses the toast once none is open. An
+     * Escape a popup on the page closed on, by calling `preventDefault()`,
+     * leaves it up too. Default: true.
      */
     cancelable?: boolean;
     /** Text for an action button (e.g. "Undo"). */

package/dist/types/elements/Loader.d.ts

@@ -23,7 +23,8 @@ export interface LoaderProps extends Omit<React.HTMLAttributes<HTMLSpanElement>,
  *
  * The ring is `1em` square, so `textSize` scales it. It is exposed as an
  * indeterminate `progressbar` named by `ariaLabel`, and it stops spinning
- * under `prefers-reduced-motion: reduce` while staying drawn.
+ * under `prefers-reduced-motion: reduce` while staying drawn. In forced
+ * colors its two open sides take the page's color, so it stays open.
  *
  * @function
  * @param {LoaderProps} props - Props for the Loader component.

package/dist/types/form/Checkbox.d.ts

@@ -44,6 +44,17 @@ export interface CheckboxProps extends Omit<React.InputHTMLAttributes<HTMLInputE
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
     /** Whether the checkbox is disabled. */
     disabled?: boolean;
+    /**
+     * Shows the mixed state, as in a "Select all" box when some of what it
+     * covers is checked. It's a look and an announcement only: `checked` is
+     * still the value, and a click still toggles `checked`. A browser clears
+     * the mixed state on a click, so the component sets it again from this
+     * prop after every click and every render. Left unset, the component
+     * doesn't touch it, and once it has set it, going back to unset clears it
+     * once and hands it back. It has no HTML attribute, so server-rendered
+     * markup can't carry it, and a mixed box renders unmixed until hydration.
+     */
+    indeterminate?: boolean;
     /** Additional CSS classes to apply. */
     className?: string;
     /** The label/content for the checkbox. */

package/dist/types/form/Taginput.d.ts

@@ -63,7 +63,11 @@ export interface TaginputProps extends Omit<React.HTMLAttributes<HTMLDivElement>
     closable?: boolean;
     /** Attach tags visually. */
     attached?: boolean;
-    /** Maximum number of tags allowed. */
+    /**
+     * Maximum number of tags allowed. At the limit the text input isn't
+     * rendered, and neither is the suggestion list, so the field takes no more
+     * tags until one is removed.
+     */
     maxTags?: number;
     /** Maximum length of input. */
     maxlength?: number;

package/dist/types/helpers/overlayStack.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Holds this overlay's place in the stack of open overlays while `inStack`
+ * is true, from the effect after it opens until the one after it closes.
+ * Opening again puts it back on top.
+ *
+ * Returns a check for whether nothing in the stack sits above this overlay,
+ * to call when a key arrives. For an overlay in the stack, that's whether it
+ * is the topmost one. For one that isn't, such as a Toast, it's whether no
+ * overlay is open at all.
+ *
+ * @function useOverlayStack
+ * @param inStack - Whether this overlay is open and takes part.
+ * @returns A check for whether nothing in the stack is above this overlay.
+ */
+export declare function useOverlayStack(inStack: boolean): () => boolean;

package/dist/types/helpers/useLatestRef.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A ref holding the value from the latest commit, for a listener that is
+ * added once and calls whatever callback it was given most recently.
+ *
+ * A listener whose effect lists a callback prop is taken off and added again
+ * each time that callback changes, and an inline one changes on every render
+ * of its parent. React can render between two listeners for the same
+ * keypress, and the browser runs neither a listener taken off mid-event nor
+ * one added mid-event, so that keypress never reaches it (#1088). Reading the
+ * callback from here keeps the listener where it is.
+ *
+ * It's updated before paint on each commit, so a listener reads the props of
+ * the render that's on screen.
+ *
+ * @function useLatestRef
+ * @param value - The value to keep current, usually a callback prop.
+ * @returns A ref whose `current` is `value` as of the latest commit.
+ */
+export declare function useLatestRef<T>(value: T): {
+    readonly current: T;
+};

package/dist/types-cjs/components/Loading.d.ts

@@ -16,7 +16,12 @@ export type LoadingColor = 'primary' | 'link' | 'info' | 'success' | 'warning' |
 export interface LoadingProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'color'>, Omit<BulmaClassesProps, 'color' | 'backgroundColor' | 'size' | 'overlay'> {
     /** Whether the loading overlay is visible. */
     active?: boolean;
-    /** Cover the entire viewport. */
+    /**
+     * Cover the entire viewport. A full-page loading also takes its turn with
+     * Modal and Sidebar for Escape: while it's the topmost open overlay, the
+     * Modal or Sidebar under it doesn't answer Escape or hold Tab, whether or
+     * not the loading can be cancelled.
+     */
     isFullPage?: boolean;
     /** Size of the loading spinner. */
     size?: 'small' | 'medium' | 'large';
@@ -24,8 +29,13 @@ export interface LoadingProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
     color?: LoadingColor;
     /**
      * Show a cancel button and allow closing, by a click on the overlay or by
-     * Escape. An Escape a popup on the page closed on, by calling
-     * `preventDefault()`, doesn't cancel.
+     * Escape. With `isFullPage`, the loading is an overlay like Modal and
+     * Sidebar: only the topmost open overlay answers Escape, so a full-page
+     * loading shown over a Modal cancels first, and the Modal closes on the
+     * next Escape. Without it, Escape cancels once no Modal, Dialog, Sidebar or
+     * full-page Loading is open. Either way it marks the Escape it cancels on as
+     * used with `preventDefault()`. An Escape a popup on the page closed on, by
+     * calling `preventDefault()`, doesn't cancel.
      */
     canCancel?: boolean;
     /** Callback when cancel is triggered. */

package/dist/types-cjs/components/Menu.d.ts

@@ -56,7 +56,16 @@ export interface MenuItemOwnProps extends BulmaClassesProps {
     className?: string;
     /** Item content and optional nested MenuList. */
     children: React.ReactNode;
-    /** Highlight item as active. */
+    /**
+     * Marks the item as the current one. It adds Bulma's `is-active` class, and
+     * `aria-current="page"` on the element `as` renders, so assistive tech can
+     * tell which item is current too. An `aria-current` you pass wins, even
+     * `undefined`: use it to say something else (`"location"` for a section of
+     * one page, say), or `aria-current={false}` to turn it off. A menu should
+     * mark one page, so when the section above the current page is `active` too,
+     * give it `aria-current="location"`, and give an `active` item that isn't
+     * navigation, such as an `as="button"` filter, `aria-current={false}`.
+     */
     active?: boolean;
     /** Inline styles for the wrapping `<li>`. */
     style?: React.CSSProperties;
@@ -91,6 +100,10 @@ export type MenuItemProps<T extends React.ElementType = 'a'> = MenuItemOwnProps
 /**
  * MenuItem supports `as` prop for custom link components, e.g., react-router-dom Link.
  *
+ * Give each item an `href`, a router link through `as`, or `as="button"`, so
+ * the keyboard can reach it: an `<a>` with no `href` isn't a link, and Tab
+ * skips it.
+ *
  * @function
  * @param {MenuItemProps} props - Props for the MenuItem component.
  * @param {React.Ref} ref - Forwarded ref to the inner element `as` renders.

package/dist/types-cjs/components/Modal.d.ts

@@ -30,10 +30,13 @@ export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     children?: React.ReactNode;
     /**
      * Close the modal when the Escape key is pressed (calls `onClose`). Only the
-     * topmost open modal responds, so Escape closes one layer at a time. A popup
-     * inside it, such as a Dropdown's menu or a date picker's calendar, takes
-     * its own Escape first, and so does content that calls `preventDefault()`
-     * on it.
+     * topmost open overlay responds, whichever Modal, Dialog, Sidebar or
+     * full-page Loading opened last, so Escape closes one layer at a time. The
+     * modal marks the Escape it closes on as used with `preventDefault()`, and
+     * a Toast waits until no overlay is open. Turned off, a modal on top still
+     * keeps Escape from the layers under it. A popup inside it, such as a
+     * Dropdown's menu or a date picker's calendar, takes its own Escape first,
+     * and so does content that calls `preventDefault()` on it.
      * @defaultValue true
      */
     closeOnEscape?: boolean;

package/dist/types-cjs/components/Sidebar.d.ts

@@ -25,9 +25,14 @@ export interface SidebarProps extends Omit<React.HTMLAttributes<HTMLElement>, 'c
     /** Close sidebar when overlay is clicked. Default: true. */
     overlayClose?: boolean;
     /**
-     * Close sidebar on Escape key. A popup inside it, such as a Dropdown's menu
-     * or a date picker's calendar, takes its own Escape first, and so does
-     * content that calls `preventDefault()` on it. Default: true.
+     * Close sidebar on Escape key. Only the topmost open overlay responds,
+     * whichever Modal, Dialog, Sidebar or full-page Loading opened last, so
+     * Escape closes one layer at a time. The sidebar marks the Escape it closes
+     * on as used with `preventDefault()`, and a Toast waits until no overlay is
+     * open. Turned off, a sidebar on top still keeps Escape from the layers
+     * under it. A popup inside it, such as a Dropdown's menu or a date picker's
+     * calendar, takes its own Escape first, and so does content that calls
+     * `preventDefault()` on it. Default: true.
      */
     escapeClose?: boolean;
     /** Allow closing the sidebar. Default: true. */

package/dist/types-cjs/components/Steps.d.ts

@@ -8,7 +8,11 @@ export type StepsColor = 'primary' | 'link' | 'info' | 'success' | 'warning' | '
  * Props for individual Step items.
  */
 export interface StepItemProps {
-    /** Step label/title */
+    /**
+     * Step label/title. On a `clickable` step it's rendered inside the step's
+     * `<button>`, so it has to be phrasing content, like text, a `<span>` or an
+     * icon, with no link, button or other control in it.
+     */
     label?: React.ReactNode;
     /** Icon for the step marker */
     icon?: React.ReactNode;
@@ -17,7 +21,11 @@ export interface StepItemProps {
      * @defaultValue '✓'
      */
     completedIcon?: React.ReactNode;
-    /** Whether this step is clickable */
+    /**
+     * Whether this step is clickable. A clickable step puts its marker and
+     * label in a `<button type="button">` inside its list item, which calls
+     * `onStepClick`, and the current step's `aria-current` goes on that button.
+     */
     clickable?: boolean;
     /** Additional CSS classes. */
     className?: string;
@@ -44,7 +52,11 @@ export interface StepsProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     rounded?: boolean;
     /** Vertical layout. */
     vertical?: boolean;
-    /** Position of labels. */
+    /**
+     * Position of labels. `right` and `left` mean the end and the start of the
+     * line, so in a right-to-left page `right` puts each label to the left of
+     * its marker, and `left` to the right.
+     */
     labelPosition?: 'bottom' | 'right' | 'left';
     /** Mobile display mode. */
     mobileMode?: 'minimal' | 'compact' | 'right';
@@ -75,11 +87,21 @@ export interface StepProps extends Omit<React.LiHTMLAttributes<HTMLLIElement>, '
     isActive?: boolean;
     /** Whether this step is completed */
     isCompleted?: boolean;
-    /** Step label/title */
+    /**
+     * Step label/title, or pass it as `children`. On a `clickable` step it's
+     * rendered inside the step's `<button>`, so it has to be phrasing content,
+     * like text, a `<span>` or an icon, with no link, button or other control
+     * in it.
+     */
     label?: React.ReactNode;
     /** Icon for the step marker */
     icon?: React.ReactNode;
-    /** Whether this step is clickable */
+    /**
+     * Whether this step is clickable. A clickable step puts its marker and
+     * label in a `<button type="button">` inside the `<li>`, which calls
+     * `onClick`, and `aria-current` goes on that button. The `<li>` keeps the
+     * rest of the props.
+     */
     clickable?: boolean;
     /** Click handler */
     onClick?: () => void;

package/dist/types-cjs/components/Toast.d.ts

@@ -35,8 +35,11 @@ export interface ToastProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     /** Pause auto-close timer on hover. Default: false. */
     pauseOnHover?: boolean;
     /**
-     * Whether the toast can be dismissed with Escape. An Escape a popup on the
-     * page closed on, by calling `preventDefault()`, leaves it up. Default: true.
+     * Whether the toast can be dismissed with Escape. While a Modal, Dialog,
+     * Sidebar or full-page Loading is open, Escape goes to that overlay and the
+     * toast stays up, so Escape dismisses the toast once none is open. An
+     * Escape a popup on the page closed on, by calling `preventDefault()`,
+     * leaves it up too. Default: true.
      */
     cancelable?: boolean;
     /** Text for an action button (e.g. "Undo"). */

package/dist/types-cjs/elements/Loader.d.ts

@@ -23,7 +23,8 @@ export interface LoaderProps extends Omit<React.HTMLAttributes<HTMLSpanElement>,
  *
  * The ring is `1em` square, so `textSize` scales it. It is exposed as an
  * indeterminate `progressbar` named by `ariaLabel`, and it stops spinning
- * under `prefers-reduced-motion: reduce` while staying drawn.
+ * under `prefers-reduced-motion: reduce` while staying drawn. In forced
+ * colors its two open sides take the page's color, so it stays open.
  *
  * @function
  * @param {LoaderProps} props - Props for the Loader component.

package/dist/types-cjs/form/Checkbox.d.ts

@@ -44,6 +44,17 @@ export interface CheckboxProps extends Omit<React.InputHTMLAttributes<HTMLInputE
     textColor?: (typeof validColors)[number] | 'inherit' | 'current';
     /** Whether the checkbox is disabled. */
     disabled?: boolean;
+    /**
+     * Shows the mixed state, as in a "Select all" box when some of what it
+     * covers is checked. It's a look and an announcement only: `checked` is
+     * still the value, and a click still toggles `checked`. A browser clears
+     * the mixed state on a click, so the component sets it again from this
+     * prop after every click and every render. Left unset, the component
+     * doesn't touch it, and once it has set it, going back to unset clears it
+     * once and hands it back. It has no HTML attribute, so server-rendered
+     * markup can't carry it, and a mixed box renders unmixed until hydration.
+     */
+    indeterminate?: boolean;
     /** Additional CSS classes to apply. */
     className?: string;
     /** The label/content for the checkbox. */

package/dist/types-cjs/form/Taginput.d.ts

@@ -63,7 +63,11 @@ export interface TaginputProps extends Omit<React.HTMLAttributes<HTMLDivElement>
     closable?: boolean;
     /** Attach tags visually. */
     attached?: boolean;
-    /** Maximum number of tags allowed. */
+    /**
+     * Maximum number of tags allowed. At the limit the text input isn't
+     * rendered, and neither is the suggestion list, so the field takes no more
+     * tags until one is removed.
+     */
     maxTags?: number;
     /** Maximum length of input. */
     maxlength?: number;

package/dist/types-cjs/helpers/overlayStack.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Holds this overlay's place in the stack of open overlays while `inStack`
+ * is true, from the effect after it opens until the one after it closes.
+ * Opening again puts it back on top.
+ *
+ * Returns a check for whether nothing in the stack sits above this overlay,
+ * to call when a key arrives. For an overlay in the stack, that's whether it
+ * is the topmost one. For one that isn't, such as a Toast, it's whether no
+ * overlay is open at all.
+ *
+ * @function useOverlayStack
+ * @param inStack - Whether this overlay is open and takes part.
+ * @returns A check for whether nothing in the stack is above this overlay.
+ */
+export declare function useOverlayStack(inStack: boolean): () => boolean;

package/dist/types-cjs/helpers/useLatestRef.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A ref holding the value from the latest commit, for a listener that is
+ * added once and calls whatever callback it was given most recently.
+ *
+ * A listener whose effect lists a callback prop is taken off and added again
+ * each time that callback changes, and an inline one changes on every render
+ * of its parent. React can render between two listeners for the same
+ * keypress, and the browser runs neither a listener taken off mid-event nor
+ * one added mid-event, so that keypress never reaches it (#1088). Reading the
+ * callback from here keeps the listener where it is.
+ *
+ * It's updated before paint on each commit, so a listener reads the props of
+ * the render that's on screen.
+ *
+ * @function useLatestRef
+ * @param value - The value to keep current, usually a callback prop.
+ * @returns A ref whose `current` is `value` as of the latest commit.
+ */
+export declare function useLatestRef<T>(value: T): {
+    readonly current: T;
+};