@allxsmith/bestax-bulma 5.34.1 → 5.34.2

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

@@ -22,7 +22,11 @@ export interface LoadingProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
     size?: 'small' | 'medium' | 'large';
     /** Color variant for the spinner. Default is light grey. */
     color?: LoadingColor;
-    /** Show a cancel button and allow closing. */
+    /**
+     * 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.
+     */
     canCancel?: boolean;
     /** Callback when cancel is triggered. */
     onCancel?: () => void;

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

@@ -30,7 +30,10 @@ 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.
+     * 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.
      * @defaultValue true
      */
     closeOnEscape?: boolean;

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

@@ -24,7 +24,11 @@ export interface SidebarProps extends Omit<React.HTMLAttributes<HTMLElement>, 'c
     overlay?: boolean;
     /** Close sidebar when overlay is clicked. Default: true. */
     overlayClose?: boolean;
-    /** Close sidebar on Escape key. Default: true. */
+    /**
+     * 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.
+     */
     escapeClose?: boolean;
     /** Allow closing the sidebar. Default: true. */
     canCancel?: boolean;

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

@@ -34,7 +34,10 @@ export interface ToastProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     rounded?: boolean;
     /** Pause auto-close timer on hover. Default: false. */
     pauseOnHover?: boolean;
-    /** Whether the toast can be dismissed with Escape. Default: true. */
+    /**
+     * 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.
+     */
     cancelable?: boolean;
     /** Text for an action button (e.g. "Undo"). */
     actionText?: string;

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

@@ -31,7 +31,12 @@ export interface AutocompleteProps extends Omit<React.HTMLAttributes<HTMLDivElem
     data: AutocompleteItem[] | string[];
     /** The current input value (controlled). */
     value?: string;
-    /** The selected item (controlled). */
+    /**
+     * Does nothing: Autocomplete doesn't read it.
+     *
+     * @deprecated Nothing reads it, and `onSelect` is what reports a pick. It
+     * will be removed in the next major version.
+     */
     selected?: AutocompleteItem | string | null;
     /** Placeholder text for the input. */
     placeholder?: string;
@@ -54,7 +59,13 @@ export interface AutocompleteProps extends Omit<React.HTMLAttributes<HTMLDivElem
     selectOnClickOutside?: boolean;
     /** Maximum dropdown height in pixels. */
     maxHeight?: number;
-    /** Render as dropdown style. */
+    /**
+     * Does nothing: Autocomplete doesn't read it, and always shows its
+     * suggestions in a dropdown.
+     *
+     * @deprecated It will be removed in the next major version, with nothing
+     * in its place.
+     */
     dropdown?: boolean;
     /**
      * Show a loading spinner in the input.

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

@@ -22,7 +22,11 @@ export interface LoadingProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
     size?: 'small' | 'medium' | 'large';
     /** Color variant for the spinner. Default is light grey. */
     color?: LoadingColor;
-    /** Show a cancel button and allow closing. */
+    /**
+     * 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.
+     */
     canCancel?: boolean;
     /** Callback when cancel is triggered. */
     onCancel?: () => void;

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

@@ -30,7 +30,10 @@ 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.
+     * 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.
      * @defaultValue true
      */
     closeOnEscape?: boolean;

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

@@ -24,7 +24,11 @@ export interface SidebarProps extends Omit<React.HTMLAttributes<HTMLElement>, 'c
     overlay?: boolean;
     /** Close sidebar when overlay is clicked. Default: true. */
     overlayClose?: boolean;
-    /** Close sidebar on Escape key. Default: true. */
+    /**
+     * 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.
+     */
     escapeClose?: boolean;
     /** Allow closing the sidebar. Default: true. */
     canCancel?: boolean;

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

@@ -34,7 +34,10 @@ export interface ToastProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     rounded?: boolean;
     /** Pause auto-close timer on hover. Default: false. */
     pauseOnHover?: boolean;
-    /** Whether the toast can be dismissed with Escape. Default: true. */
+    /**
+     * 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.
+     */
     cancelable?: boolean;
     /** Text for an action button (e.g. "Undo"). */
     actionText?: string;

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

@@ -31,7 +31,12 @@ export interface AutocompleteProps extends Omit<React.HTMLAttributes<HTMLDivElem
     data: AutocompleteItem[] | string[];
     /** The current input value (controlled). */
     value?: string;
-    /** The selected item (controlled). */
+    /**
+     * Does nothing: Autocomplete doesn't read it.
+     *
+     * @deprecated Nothing reads it, and `onSelect` is what reports a pick. It
+     * will be removed in the next major version.
+     */
     selected?: AutocompleteItem | string | null;
     /** Placeholder text for the input. */
     placeholder?: string;
@@ -54,7 +59,13 @@ export interface AutocompleteProps extends Omit<React.HTMLAttributes<HTMLDivElem
     selectOnClickOutside?: boolean;
     /** Maximum dropdown height in pixels. */
     maxHeight?: number;
-    /** Render as dropdown style. */
+    /**
+     * Does nothing: Autocomplete doesn't read it, and always shows its
+     * suggestions in a dropdown.
+     *
+     * @deprecated It will be removed in the next major version, with nothing
+     * in its place.
+     */
     dropdown?: boolean;
     /**
      * Show a loading spinner in the input.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allxsmith/bestax-bulma",
-  "version": "5.34.1",
+  "version": "5.34.2",
   "description": "A fully-typed React component library for the Bulma CSS framework. Build modern UIs quickly with reusable, accessible, and customizable Bulma-based React components.",
   "main": "dist/index.cjs",
   "module": "dist/index.esm.js",