@allxsmith/bestax-bulma 5.26.4 → 5.26.5

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

@@ -37,7 +37,12 @@ export interface AutocompleteProps extends Omit<React.HTMLAttributes<HTMLDivElem
     placeholder?: string;
     /** Object property to use as the display field. */
     field?: string;
-    /** Whether to show a clear button. */
+    /**
+     * Whether to show a clear button while the input holds a value.
+     * It hides while the input is disabled, and gives way to a loading
+     * spinner at the same right edge: the one `loading` draws, or that of a
+     * `Control` with `isLoading` around the Autocomplete.
+     */
     clearable?: boolean;
     /** Open dropdown when input is focused. */
     openOnFocus?: boolean;

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

@@ -5,9 +5,12 @@ import { DateInputBaseProps } from './DateInputBase.js';
 /**
  * Props for the DateInput convenience wrapper. Extends `DateInputBaseProps`
  * with Field-level (label, horizontal) and Control-level (icons, loading) props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. In `inline` mode it renders no `Control` anywhere,
+ * so they do nothing inside a `Control` or out, and warn in development
+ * there too. Inside an outer `Field`, or a `Control` with no `Field` around
+ * it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the
@@ -52,7 +55,8 @@ export interface DateInputProps extends DateInputBaseProps {
     /**
      * Shows a loading spinner on the `Control` it renders, and hides the
      * launcher (`triggerIcon`) while it does. Inside your own `Control` it
-     * renders none, so this draws nothing; set `isLoading` on that `Control`.
+     * renders none, so this draws nothing and warns in development; set
+     * `isLoading` on that `Control`.
      * Under `prefers-reduced-motion: reduce` the spinner stops and stays
      * drawn (with bestax's CSS loaded).
      */

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

@@ -5,9 +5,12 @@ import { DateTimeInputBaseProps } from './DateTimeInputBase.js';
 /**
  * Props for the DateTimeInput convenience wrapper. Extends
  * `DateTimeInputBaseProps` with Field-level and Control-level props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. In `inline` mode it renders no `Control` anywhere,
+ * so they do nothing inside a `Control` or out, and warn in development
+ * there too. Inside an outer `Field`, or a `Control` with no `Field` around
+ * it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the
@@ -50,7 +53,8 @@ export interface DateTimeInputProps extends DateTimeInputBaseProps {
     /**
      * Shows a loading spinner on the `Control` it renders, and hides the
      * launcher (`triggerIcon`) while it does. Inside your own `Control` it
-     * renders none, so this draws nothing; set `isLoading` on that `Control`.
+     * renders none, so this draws nothing and warns in development; set
+     * `isLoading` on that `Control`.
      * Under `prefers-reduced-motion: reduce` the spinner stops and stays
      * drawn (with bestax's CSS loaded).
      */

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

@@ -1,4 +1,5 @@
 import React from 'react';
+import type { ControlBaseProps } from './Control.js';
 /**
  * Hook to detect if the component is inside a Field wrapper.
  * Form components use this to skip rendering their own Field.
@@ -43,6 +44,52 @@ interface OwnFieldOptions extends FieldShapingProps {
  * Internal; not part of the public API.
  */
 export declare const rendersOwnField: (component: string, options: OwnFieldOptions) => boolean;
+/** The props a convenience form wrapper hands its own `Control`. Internal. */
+export interface ControlLevelProps {
+    /** Shows the `Control`'s loading spinner. */
+    isLoading?: boolean;
+    /** The `Control`'s left icon. */
+    iconLeft?: ControlBaseProps['iconLeft'];
+    /** Shortcut for the left icon's name. */
+    iconLeftName?: string;
+    /** Shortcut for the left icon's size. */
+    iconLeftSize?: ControlBaseProps['iconLeftSize'];
+    /** The `Control`'s right icon. */
+    iconRight?: ControlBaseProps['iconRight'];
+    /** Shortcut for the right icon's name. */
+    iconRightName?: string;
+    /** Shortcut for the right icon's size. */
+    iconRightSize?: ControlBaseProps['iconRightSize'];
+    /** Reserves the `Control`'s left icon space. */
+    hasIconsLeft?: boolean;
+    /** Reserves the `Control`'s right icon space. */
+    hasIconsRight?: boolean;
+    /** Expands the `Control`. */
+    isExpanded?: boolean;
+    /** Set on the `Control` as its `size`. */
+    controlSize?: ControlBaseProps['size'];
+    /** Set on the `Control` as its class. */
+    controlClassName?: string;
+}
+interface OwnControlOptions extends ControlLevelProps {
+    /** `useInsideControl()` as the wrapper read it. */
+    insideControl: boolean;
+    /** A picker's `inline`, which renders no `Control` inside one or out. */
+    inline?: boolean;
+}
+/**
+ * Whether a convenience form wrapper renders a `Control` of its own (#921):
+ * only outside one. Inside a `Control` it renders none, so the props it
+ * would have handed its own do nothing there, and it warns in development,
+ * naming them and saying to set them on that `Control`. An `inline` picker
+ * renders none in either place, so it drops them inside a `Control` or not,
+ * and its warning says so without pointing at a `Control`. A wrapper passes
+ * only the props it hands its own `Control`, as the caller gave them, so a
+ * default the wrapper fills in itself never warns. A prop counts when it is
+ * truthy, since a falsy one would change nothing on a `Control` either.
+ * Internal; not part of the public API.
+ */
+export declare const rendersOwnControl: (component: string, options: OwnControlOptions) => boolean;
 /**
  * The id a labeled Field wants its single composed control to adopt (#495).
  * `undefined` outside a Field, in unlabeled/grouped/addons Fields, or when the

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

@@ -8,9 +8,10 @@ import { InputBaseProps } from './InputBase.js';
  * Composes Field, Control, and Input into a single convenience component.
  * Supports all Input props, plus Field-level (label, horizontal) and
  * Control-level (icons, loading) props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. Inside an outer `Field`, or a `Control` with no
+ * `Field` around it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the

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

@@ -57,6 +57,9 @@ export interface NumberinputProps extends Omit<React.InputHTMLAttributes<HTMLInp
      * Shows a loading spinner on the input's control.
      * Under `prefers-reduced-motion: reduce` the spinner stops and stays
      * drawn (with bestax's CSS loaded).
+     * Use this rather than `isLoading` on a `Control` around the Numberinput:
+     * that spinner sits at the `Control`'s right edge, on top of whichever
+     * button is there, while this one stays inside the input.
      */
     isLoading?: boolean;
     /** Enables exponential step increments when holding buttons. */

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

@@ -8,9 +8,10 @@ import { SelectBaseProps } from './SelectBase.js';
  * Composes Field, Control, and SelectBase into a single convenience component.
  * Supports all SelectBase props, plus Field-level (label, horizontal) and
  * Control-level (icons) props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. Inside an outer `Field`, or a `Control` with no
+ * `Field` around it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the

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

@@ -8,9 +8,10 @@ import { TextAreaBaseProps } from './TextAreaBase.js';
  * Composes Field, Control, and TextAreaBase into a single convenience component.
  * Supports all TextAreaBase props, plus Field-level (label, horizontal) and
  * Control-level (loading) props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. Inside an outer `Field`, or a `Control` with no
+ * `Field` around it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the

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

@@ -5,9 +5,12 @@ import { TimeInputBaseProps } from './TimeInputBase.js';
 /**
  * Props for the TimeInput convenience wrapper. Extends `TimeInputBaseProps`
  * with Field-level (label, horizontal) and Control-level (icons, loading) props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. In `inline` mode it renders no `Control` anywhere,
+ * so they do nothing inside a `Control` or out, and warn in development
+ * there too. Inside an outer `Field`, or a `Control` with no `Field` around
+ * it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the
@@ -52,7 +55,8 @@ export interface TimeInputProps extends TimeInputBaseProps {
     /**
      * Shows a loading spinner on the `Control` it renders, and hides the
      * launcher (`triggerIcon`) while it does. Inside your own `Control` it
-     * renders none, so this draws nothing; set `isLoading` on that `Control`.
+     * renders none, so this draws nothing and warns in development; set
+     * `isLoading` on that `Control`.
      * Under `prefers-reduced-motion: reduce` the spinner stops and stays
      * drawn (with bestax's CSS loaded).
      */

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

@@ -37,7 +37,12 @@ export interface AutocompleteProps extends Omit<React.HTMLAttributes<HTMLDivElem
     placeholder?: string;
     /** Object property to use as the display field. */
     field?: string;
-    /** Whether to show a clear button. */
+    /**
+     * Whether to show a clear button while the input holds a value.
+     * It hides while the input is disabled, and gives way to a loading
+     * spinner at the same right edge: the one `loading` draws, or that of a
+     * `Control` with `isLoading` around the Autocomplete.
+     */
     clearable?: boolean;
     /** Open dropdown when input is focused. */
     openOnFocus?: boolean;

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

@@ -5,9 +5,12 @@ import { DateInputBaseProps } from './DateInputBase.js';
 /**
  * Props for the DateInput convenience wrapper. Extends `DateInputBaseProps`
  * with Field-level (label, horizontal) and Control-level (icons, loading) props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. In `inline` mode it renders no `Control` anywhere,
+ * so they do nothing inside a `Control` or out, and warn in development
+ * there too. Inside an outer `Field`, or a `Control` with no `Field` around
+ * it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the
@@ -52,7 +55,8 @@ export interface DateInputProps extends DateInputBaseProps {
     /**
      * Shows a loading spinner on the `Control` it renders, and hides the
      * launcher (`triggerIcon`) while it does. Inside your own `Control` it
-     * renders none, so this draws nothing; set `isLoading` on that `Control`.
+     * renders none, so this draws nothing and warns in development; set
+     * `isLoading` on that `Control`.
      * Under `prefers-reduced-motion: reduce` the spinner stops and stays
      * drawn (with bestax's CSS loaded).
      */

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

@@ -5,9 +5,12 @@ import { DateTimeInputBaseProps } from './DateTimeInputBase.js';
 /**
  * Props for the DateTimeInput convenience wrapper. Extends
  * `DateTimeInputBaseProps` with Field-level and Control-level props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. In `inline` mode it renders no `Control` anywhere,
+ * so they do nothing inside a `Control` or out, and warn in development
+ * there too. Inside an outer `Field`, or a `Control` with no `Field` around
+ * it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the
@@ -50,7 +53,8 @@ export interface DateTimeInputProps extends DateTimeInputBaseProps {
     /**
      * Shows a loading spinner on the `Control` it renders, and hides the
      * launcher (`triggerIcon`) while it does. Inside your own `Control` it
-     * renders none, so this draws nothing; set `isLoading` on that `Control`.
+     * renders none, so this draws nothing and warns in development; set
+     * `isLoading` on that `Control`.
      * Under `prefers-reduced-motion: reduce` the spinner stops and stays
      * drawn (with bestax's CSS loaded).
      */

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

@@ -1,4 +1,5 @@
 import React from 'react';
+import type { ControlBaseProps } from './Control.js';
 /**
  * Hook to detect if the component is inside a Field wrapper.
  * Form components use this to skip rendering their own Field.
@@ -43,6 +44,52 @@ interface OwnFieldOptions extends FieldShapingProps {
  * Internal; not part of the public API.
  */
 export declare const rendersOwnField: (component: string, options: OwnFieldOptions) => boolean;
+/** The props a convenience form wrapper hands its own `Control`. Internal. */
+export interface ControlLevelProps {
+    /** Shows the `Control`'s loading spinner. */
+    isLoading?: boolean;
+    /** The `Control`'s left icon. */
+    iconLeft?: ControlBaseProps['iconLeft'];
+    /** Shortcut for the left icon's name. */
+    iconLeftName?: string;
+    /** Shortcut for the left icon's size. */
+    iconLeftSize?: ControlBaseProps['iconLeftSize'];
+    /** The `Control`'s right icon. */
+    iconRight?: ControlBaseProps['iconRight'];
+    /** Shortcut for the right icon's name. */
+    iconRightName?: string;
+    /** Shortcut for the right icon's size. */
+    iconRightSize?: ControlBaseProps['iconRightSize'];
+    /** Reserves the `Control`'s left icon space. */
+    hasIconsLeft?: boolean;
+    /** Reserves the `Control`'s right icon space. */
+    hasIconsRight?: boolean;
+    /** Expands the `Control`. */
+    isExpanded?: boolean;
+    /** Set on the `Control` as its `size`. */
+    controlSize?: ControlBaseProps['size'];
+    /** Set on the `Control` as its class. */
+    controlClassName?: string;
+}
+interface OwnControlOptions extends ControlLevelProps {
+    /** `useInsideControl()` as the wrapper read it. */
+    insideControl: boolean;
+    /** A picker's `inline`, which renders no `Control` inside one or out. */
+    inline?: boolean;
+}
+/**
+ * Whether a convenience form wrapper renders a `Control` of its own (#921):
+ * only outside one. Inside a `Control` it renders none, so the props it
+ * would have handed its own do nothing there, and it warns in development,
+ * naming them and saying to set them on that `Control`. An `inline` picker
+ * renders none in either place, so it drops them inside a `Control` or not,
+ * and its warning says so without pointing at a `Control`. A wrapper passes
+ * only the props it hands its own `Control`, as the caller gave them, so a
+ * default the wrapper fills in itself never warns. A prop counts when it is
+ * truthy, since a falsy one would change nothing on a `Control` either.
+ * Internal; not part of the public API.
+ */
+export declare const rendersOwnControl: (component: string, options: OwnControlOptions) => boolean;
 /**
  * The id a labeled Field wants its single composed control to adopt (#495).
  * `undefined` outside a Field, in unlabeled/grouped/addons Fields, or when the

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

@@ -8,9 +8,10 @@ import { InputBaseProps } from './InputBase.js';
  * Composes Field, Control, and Input into a single convenience component.
  * Supports all Input props, plus Field-level (label, horizontal) and
  * Control-level (icons, loading) props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. Inside an outer `Field`, or a `Control` with no
+ * `Field` around it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the

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

@@ -57,6 +57,9 @@ export interface NumberinputProps extends Omit<React.InputHTMLAttributes<HTMLInp
      * Shows a loading spinner on the input's control.
      * Under `prefers-reduced-motion: reduce` the spinner stops and stays
      * drawn (with bestax's CSS loaded).
+     * Use this rather than `isLoading` on a `Control` around the Numberinput:
+     * that spinner sits at the `Control`'s right edge, on top of whichever
+     * button is there, while this one stays inside the input.
      */
     isLoading?: boolean;
     /** Enables exponential step increments when holding buttons. */

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

@@ -8,9 +8,10 @@ import { SelectBaseProps } from './SelectBase.js';
  * Composes Field, Control, and SelectBase into a single convenience component.
  * Supports all SelectBase props, plus Field-level (label, horizontal) and
  * Control-level (icons) props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. Inside an outer `Field`, or a `Control` with no
+ * `Field` around it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the

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

@@ -8,9 +8,10 @@ import { TextAreaBaseProps } from './TextAreaBase.js';
  * Composes Field, Control, and TextAreaBase into a single convenience component.
  * Supports all TextAreaBase props, plus Field-level (label, horizontal) and
  * Control-level (loading) props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. Inside an outer `Field`, or a `Control` with no
+ * `Field` around it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the

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

@@ -5,9 +5,12 @@ import { TimeInputBaseProps } from './TimeInputBase.js';
 /**
  * Props for the TimeInput convenience wrapper. Extends `TimeInputBaseProps`
  * with Field-level (label, horizontal) and Control-level (icons, loading) props.
- * Inside an existing `Control` it renders no `Control` of its own, so set the
- * Control-level props on that `Control` instead. Inside an outer `Field`, or a
- * `Control` with no `Field` around it, it renders no `Field` of its own either.
+ * Inside an existing `Control` it renders no `Control` of its own, so its
+ * Control-level props do nothing there and warn in development; set them on
+ * that `Control` instead. In `inline` mode it renders no `Control` anywhere,
+ * so they do nothing inside a `Control` or out, and warn in development
+ * there too. Inside an outer `Field`, or a `Control` with no `Field` around
+ * it, it renders no `Field` of its own either.
  * The exception is `label`, `message`, `horizontal` or `fieldClassName` in that
  * bare `Control`: it keeps a `Field` for them, nested in the `.control`, and
  * warns in development. Wrap the `Control` in a `Field` instead, and set the
@@ -52,7 +55,8 @@ export interface TimeInputProps extends TimeInputBaseProps {
     /**
      * Shows a loading spinner on the `Control` it renders, and hides the
      * launcher (`triggerIcon`) while it does. Inside your own `Control` it
-     * renders none, so this draws nothing; set `isLoading` on that `Control`.
+     * renders none, so this draws nothing and warns in development; set
+     * `isLoading` on that `Control`.
      * Under `prefers-reduced-motion: reduce` the spinner stops and stays
      * drawn (with bestax's CSS loaded).
      */