@allxsmith/bestax-bulma 5.53.0 → 5.54.0

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

@@ -19,7 +19,7 @@ export interface AvatarsProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
     spacing?: AvatarsSpacing | number;
     /** Lay the avatars out side by side (non-overlapping), using `spacing` as the gap. */
     spaced?: boolean;
-    /** Builds the surplus avatar's accessible name from the hidden count, for localization. Default: `` `${count} more` ``. */
+    /** Builds the surplus avatar's accessible name from the hidden count, for localization. Default: `` `${count} more` ``. Inside a `LocaleProvider` with a `locale`, the visible `+count` and the count in the default name are written the way that locale writes numbers. */
     surplusLabel?: (count: number) => string;
     /** `Avatar` elements to render inside the group. */
     children?: React.ReactNode;

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

@@ -15,7 +15,7 @@ export interface BadgeProps extends Omit<React.HTMLAttributes<HTMLSpanElement>,
     className?: string;
     /** Additional CSS classes applied to the badge pill itself (unprefixed, like `Tooltip`'s `tooltipClassName`). */
     badgeClassName?: string;
-    /** Count, short text, or a custom node to display; omit with `dot` for a plain dot. `max`/`showZero` apply only to numeric content. */
+    /** Count, short text, or a custom node to display; omit with `dot` for a plain dot. `max`/`showZero` apply only to numeric content. A numeric count is written the way the `locale` of a `LocaleProvider` around it writes numbers. */
     content?: React.ReactNode;
     /** Numeric `content` above this renders as `"{max}+"`. A negative or non-integer value falls back to the default. */
     max?: number;

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

@@ -74,8 +74,10 @@ export interface CommandActionsProps extends CommandBaseProps {
     /**
      * The actions, for a Command that renders the field, the list, the groups
      * and the empty message itself. Typing filters them by label, keywords and
-     * description, ignoring case, with label matches first. Leave it out to
-     * build the Command from parts.
+     * description, ignoring case, with label matches first. Inside a
+     * `LocaleProvider` with a `locale`, it ignores accents too where that
+     * language does, so "cafe" finds "Café". Leave it out to build the
+     * Command from parts.
      */
     actions: CommandAction[];
     /**

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

@@ -61,6 +61,9 @@ export interface PaginationProps extends React.HTMLAttributes<HTMLElement>, Omit
     /**
      * The accessible name of a page's link, when rendering from `total`, since
      * its content is only the number (`page => 'Page ' + page` by default).
+     * Inside a `LocaleProvider` with a `locale`, the number on the link, and
+     * in the default name, is written the way that locale writes numbers, so
+     * the name still holds the text on screen.
      */
     getPageLabel?: (page: number) => string;
     /** Additional CSS classes. */

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

@@ -105,7 +105,10 @@ export interface StepProps extends Omit<React.LiHTMLAttributes<HTMLLIElement>, '
     clickable?: boolean;
     /** Click handler */
     onClick?: () => void;
-    /** Step number to display in marker (1-indexed) */
+    /**
+     * Step number to display in marker (1-indexed), written the way the
+     * `locale` of a `LocaleProvider` around it writes numbers.
+     */
     stepNumber?: number;
     /**
      * Icon shown when the step is completed.

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

@@ -35,8 +35,9 @@ export interface RingProgressProps extends Omit<React.HTMLAttributes<HTMLDivElem
      * Several values around one ring, in order clockwise from the top, each
      * with its own color and label. The ring is then an image whose name
      * writes them out, such as "Storage: Documents 40%, Photos 15%", since a
-     * screen reader can't take several values from one element. A total over
-     * `max` fills the ring and stops.
+     * screen reader can't take several values from one element. Inside a
+     * `LocaleProvider` with a `locale`, the shares are written as that locale
+     * writes a percentage. A total over `max` fills the ring and stops.
      */
     sections?: RingProgressSection[];
     /**

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

@@ -27,7 +27,12 @@ export interface AutocompleteProps extends Omit<React.HTMLAttributes<HTMLDivElem
     };
     /** Applied to the inner text input (the labellable control), not the wrapper div. */
     id?: string;
-    /** The options data to display (required). */
+    /**
+     * The options data to display (required). The list shows the options that
+     * contain what's typed, ignoring case, and inside a `LocaleProvider` with a
+     * `locale`, ignoring accents too where that language does, so "cafe" finds
+     * "Café".
+     */
     data: AutocompleteItem[] | string[];
     /** The current input value (controlled). */
     value?: string;

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

@@ -174,8 +174,9 @@ export interface ComboboxSingleDataProps extends ComboboxDataBaseProps {
      * The items, for a Combobox that renders the field, the menu, the list,
      * the groups and the empty message itself. A string is an item whose label
      * is its value, and an object is `{ value, label?, disabled?, group? }`.
-     * Typing filters the items by label, ignoring case, and the Combobox keeps
-     * the value. Leave it out to build the Combobox from parts.
+     * Typing filters the items by label, ignoring case, and inside a
+     * `LocaleProvider` with a `locale`, ignoring accents too where that
+     * language does, so "cafe" finds "Café". The Combobox keeps the value. Leave it out to build the Combobox from parts.
      */
     data: (string | ComboboxItemData)[];
     /**

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

@@ -66,7 +66,8 @@ export interface FileProps extends Omit<React.InputHTMLAttributes<HTMLInputEleme
     fileName?: string;
     /**
      * Builds the text `hasName` shows when several files are picked, from their count, for
-     * localization. Default: `` `${count} files` ``. A single pick shows its file's name.
+     * localization. Default: `` `${count} files` ``, with the count written the way the `locale`
+     * of a `LocaleProvider` around it writes numbers. A single pick shows its file's name.
      */
     pickedFilesLabel?: (count: number) => string;
 }

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

@@ -53,7 +53,10 @@ export interface RateProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'o
     size?: RateSize;
     /** Whether the rating is disabled. */
     disabled?: boolean;
-    /** Show the numeric score next to stars. */
+    /**
+     * Show the numeric score next to stars, written the way the `locale` of a
+     * `LocaleProvider` around it writes numbers.
+     */
     showScore?: boolean;
     /** Show custom text based on value. */
     showText?: boolean;

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

@@ -52,11 +52,18 @@ interface SliderBaseProps extends Omit<React.InputHTMLAttributes<HTMLInputElemen
     marks?: SliderMark[];
     /** Orientation of the slider. */
     orientation?: SliderOrientation;
-    /** Function to scale the displayed value. */
+    /**
+     * Function to scale the displayed value. With it, and no `getAriaValueText`,
+     * the scaled value is also the thumb's `aria-valuetext`.
+     */
     scale?: (value: number) => number;
     /** Function to generate the `aria-valuetext` attribute. */
     getAriaValueText?: (value: number) => string;
-    /** Format function for output display. */
+    /**
+     * Format function for output display. Without it, the output shows the
+     * value as it is, or inside a `LocaleProvider` with a `locale`, written
+     * the way that locale writes numbers, to at most three decimals.
+     */
     formatOutput?: (value: number) => string;
 }
 /**

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

@@ -42,7 +42,10 @@ export interface TaginputProps extends Omit<React.HTMLAttributes<HTMLDivElement>
      * Autocomplete suggestions. With `data` set, even to an empty array, the
      * text input is a `role="combobox"` that controls the suggestion list and
      * points `aria-activedescendant` at the highlighted suggestion. Without it
-     * there's no list, so the input stays a plain text field.
+     * there's no list, so the input stays a plain text field. The list shows
+     * the suggestions that contain what's typed, ignoring case, and inside a
+     * `LocaleProvider` with a `locale`, ignoring accents too where that
+     * language does, so "cafe" finds "Café".
      */
     data?: string[];
     /** Placeholder text when no tags. */
@@ -81,7 +84,10 @@ export interface TaginputProps extends Omit<React.HTMLAttributes<HTMLDivElement>
     rounded?: boolean;
     /** Truncates long tag text with ellipsis. */
     ellipsis?: boolean;
-    /** Shows a counter of the number of tags. */
+    /**
+     * Shows a counter of the number of tags, written the way the `locale` of
+     * a `LocaleProvider` around it writes numbers.
+     */
     hasCounter?: boolean;
     /**
      * Characters that split pasted text into tags. Each part goes through the

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

@@ -47,12 +47,15 @@ export interface LocaleProviderProps extends Omit<React.HTMLAttributes<HTMLDivEl
  * Inside it, the date and time pickers take its `locale` unless given their
  * own, and their week starts on the first day of the locale they use unless
  * `firstDayOfWeek` is set, and a picker with a `locale` of its own is read
- * like a nested provider. The library's portaled content, such as a
- * `Popover` panel, a `Modal` with `portal`, a `Toast` or a `Portal`'s
- * children, keeps the same `dir` and `lang` though it renders outside the
- * wrapper: in a container outside the wrapper, it sits in a
- * `display: contents` element that carries them. Without a provider none of
- * this changes.
+ * like a nested provider. With a `locale`, the numbers the library writes,
+ * such as page numbers and badge counts, follow it, and so does the
+ * filtering in `Combobox`, `Autocomplete`, `Taginput` and `Command`, which then ignores
+ * accents where the language treats letters as the same. The library's
+ * portaled content, such as a `Popover` panel, a `Modal` with `portal`, a
+ * `Toast` or a `Portal`'s children, keeps the same `dir` and `lang` though
+ * it renders outside the wrapper: in a container outside the wrapper, it
+ * sits in a `display: contents` element that carries them. Without a
+ * provider none of this changes.
  *
  * @function
  * @param {LocaleProviderProps} props - Props for the LocaleProvider.

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

@@ -0,0 +1,26 @@
+/** Formats a number for display, with `Intl.NumberFormat` options. */
+export type NumberFormatter = (value: number, options?: Intl.NumberFormatOptions) => string;
+/** Whether `text` contains `query`, as the locale compares letters. */
+export type TextMatcher = (text: string, query: string) => boolean;
+/**
+ * A formatter for numbers shown on screen, in the locale of the
+ * `LocaleProvider` around the component, or `null` outside one that gives a
+ * locale. Formatters are kept per set of options, since building one is the
+ * expensive part.
+ *
+ * @param own - The component's own locale, such as a picker's `locale`,
+ * which wins inside a provider.
+ */
+export declare function useNumberFormat(own?: string): NumberFormatter | null;
+/**
+ * A matcher for filtering a list by what was typed, in the locale of the
+ * `LocaleProvider` around the component, or `null` outside one that gives a
+ * locale. It compares with `Intl.Collator` at `usage: 'search'` and
+ * `sensitivity: 'base'`, so it ignores case and accents where the language
+ * treats the letters as the same: "cafe" finds "Café", while in Swedish "a"
+ * doesn't find "å", a letter of its own there. Marks the language ignores
+ * count for nothing on either side, so in Arabic محمد finds مُحَمَّد and the
+ * other way round. An empty query, or one of nothing but such marks,
+ * matches everything.
+ */
+export declare function useLocaleMatcher(): TextMatcher | null;

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

@@ -19,7 +19,7 @@ export interface AvatarsProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
     spacing?: AvatarsSpacing | number;
     /** Lay the avatars out side by side (non-overlapping), using `spacing` as the gap. */
     spaced?: boolean;
-    /** Builds the surplus avatar's accessible name from the hidden count, for localization. Default: `` `${count} more` ``. */
+    /** Builds the surplus avatar's accessible name from the hidden count, for localization. Default: `` `${count} more` ``. Inside a `LocaleProvider` with a `locale`, the visible `+count` and the count in the default name are written the way that locale writes numbers. */
     surplusLabel?: (count: number) => string;
     /** `Avatar` elements to render inside the group. */
     children?: React.ReactNode;

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

@@ -15,7 +15,7 @@ export interface BadgeProps extends Omit<React.HTMLAttributes<HTMLSpanElement>,
     className?: string;
     /** Additional CSS classes applied to the badge pill itself (unprefixed, like `Tooltip`'s `tooltipClassName`). */
     badgeClassName?: string;
-    /** Count, short text, or a custom node to display; omit with `dot` for a plain dot. `max`/`showZero` apply only to numeric content. */
+    /** Count, short text, or a custom node to display; omit with `dot` for a plain dot. `max`/`showZero` apply only to numeric content. A numeric count is written the way the `locale` of a `LocaleProvider` around it writes numbers. */
     content?: React.ReactNode;
     /** Numeric `content` above this renders as `"{max}+"`. A negative or non-integer value falls back to the default. */
     max?: number;

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

@@ -74,8 +74,10 @@ export interface CommandActionsProps extends CommandBaseProps {
     /**
      * The actions, for a Command that renders the field, the list, the groups
      * and the empty message itself. Typing filters them by label, keywords and
-     * description, ignoring case, with label matches first. Leave it out to
-     * build the Command from parts.
+     * description, ignoring case, with label matches first. Inside a
+     * `LocaleProvider` with a `locale`, it ignores accents too where that
+     * language does, so "cafe" finds "Café". Leave it out to build the
+     * Command from parts.
      */
     actions: CommandAction[];
     /**

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

@@ -61,6 +61,9 @@ export interface PaginationProps extends React.HTMLAttributes<HTMLElement>, Omit
     /**
      * The accessible name of a page's link, when rendering from `total`, since
      * its content is only the number (`page => 'Page ' + page` by default).
+     * Inside a `LocaleProvider` with a `locale`, the number on the link, and
+     * in the default name, is written the way that locale writes numbers, so
+     * the name still holds the text on screen.
      */
     getPageLabel?: (page: number) => string;
     /** Additional CSS classes. */

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

@@ -105,7 +105,10 @@ export interface StepProps extends Omit<React.LiHTMLAttributes<HTMLLIElement>, '
     clickable?: boolean;
     /** Click handler */
     onClick?: () => void;
-    /** Step number to display in marker (1-indexed) */
+    /**
+     * Step number to display in marker (1-indexed), written the way the
+     * `locale` of a `LocaleProvider` around it writes numbers.
+     */
     stepNumber?: number;
     /**
      * Icon shown when the step is completed.

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

@@ -35,8 +35,9 @@ export interface RingProgressProps extends Omit<React.HTMLAttributes<HTMLDivElem
      * Several values around one ring, in order clockwise from the top, each
      * with its own color and label. The ring is then an image whose name
      * writes them out, such as "Storage: Documents 40%, Photos 15%", since a
-     * screen reader can't take several values from one element. A total over
-     * `max` fills the ring and stops.
+     * screen reader can't take several values from one element. Inside a
+     * `LocaleProvider` with a `locale`, the shares are written as that locale
+     * writes a percentage. A total over `max` fills the ring and stops.
      */
     sections?: RingProgressSection[];
     /**

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

@@ -27,7 +27,12 @@ export interface AutocompleteProps extends Omit<React.HTMLAttributes<HTMLDivElem
     };
     /** Applied to the inner text input (the labellable control), not the wrapper div. */
     id?: string;
-    /** The options data to display (required). */
+    /**
+     * The options data to display (required). The list shows the options that
+     * contain what's typed, ignoring case, and inside a `LocaleProvider` with a
+     * `locale`, ignoring accents too where that language does, so "cafe" finds
+     * "Café".
+     */
     data: AutocompleteItem[] | string[];
     /** The current input value (controlled). */
     value?: string;

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

@@ -174,8 +174,9 @@ export interface ComboboxSingleDataProps extends ComboboxDataBaseProps {
      * The items, for a Combobox that renders the field, the menu, the list,
      * the groups and the empty message itself. A string is an item whose label
      * is its value, and an object is `{ value, label?, disabled?, group? }`.
-     * Typing filters the items by label, ignoring case, and the Combobox keeps
-     * the value. Leave it out to build the Combobox from parts.
+     * Typing filters the items by label, ignoring case, and inside a
+     * `LocaleProvider` with a `locale`, ignoring accents too where that
+     * language does, so "cafe" finds "Café". The Combobox keeps the value. Leave it out to build the Combobox from parts.
      */
     data: (string | ComboboxItemData)[];
     /**

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

@@ -66,7 +66,8 @@ export interface FileProps extends Omit<React.InputHTMLAttributes<HTMLInputEleme
     fileName?: string;
     /**
      * Builds the text `hasName` shows when several files are picked, from their count, for
-     * localization. Default: `` `${count} files` ``. A single pick shows its file's name.
+     * localization. Default: `` `${count} files` ``, with the count written the way the `locale`
+     * of a `LocaleProvider` around it writes numbers. A single pick shows its file's name.
      */
     pickedFilesLabel?: (count: number) => string;
 }

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

@@ -53,7 +53,10 @@ export interface RateProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'o
     size?: RateSize;
     /** Whether the rating is disabled. */
     disabled?: boolean;
-    /** Show the numeric score next to stars. */
+    /**
+     * Show the numeric score next to stars, written the way the `locale` of a
+     * `LocaleProvider` around it writes numbers.
+     */
     showScore?: boolean;
     /** Show custom text based on value. */
     showText?: boolean;

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

@@ -52,11 +52,18 @@ interface SliderBaseProps extends Omit<React.InputHTMLAttributes<HTMLInputElemen
     marks?: SliderMark[];
     /** Orientation of the slider. */
     orientation?: SliderOrientation;
-    /** Function to scale the displayed value. */
+    /**
+     * Function to scale the displayed value. With it, and no `getAriaValueText`,
+     * the scaled value is also the thumb's `aria-valuetext`.
+     */
     scale?: (value: number) => number;
     /** Function to generate the `aria-valuetext` attribute. */
     getAriaValueText?: (value: number) => string;
-    /** Format function for output display. */
+    /**
+     * Format function for output display. Without it, the output shows the
+     * value as it is, or inside a `LocaleProvider` with a `locale`, written
+     * the way that locale writes numbers, to at most three decimals.
+     */
     formatOutput?: (value: number) => string;
 }
 /**

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

@@ -42,7 +42,10 @@ export interface TaginputProps extends Omit<React.HTMLAttributes<HTMLDivElement>
      * Autocomplete suggestions. With `data` set, even to an empty array, the
      * text input is a `role="combobox"` that controls the suggestion list and
      * points `aria-activedescendant` at the highlighted suggestion. Without it
-     * there's no list, so the input stays a plain text field.
+     * there's no list, so the input stays a plain text field. The list shows
+     * the suggestions that contain what's typed, ignoring case, and inside a
+     * `LocaleProvider` with a `locale`, ignoring accents too where that
+     * language does, so "cafe" finds "Café".
      */
     data?: string[];
     /** Placeholder text when no tags. */
@@ -81,7 +84,10 @@ export interface TaginputProps extends Omit<React.HTMLAttributes<HTMLDivElement>
     rounded?: boolean;
     /** Truncates long tag text with ellipsis. */
     ellipsis?: boolean;
-    /** Shows a counter of the number of tags. */
+    /**
+     * Shows a counter of the number of tags, written the way the `locale` of
+     * a `LocaleProvider` around it writes numbers.
+     */
     hasCounter?: boolean;
     /**
      * Characters that split pasted text into tags. Each part goes through the

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

@@ -47,12 +47,15 @@ export interface LocaleProviderProps extends Omit<React.HTMLAttributes<HTMLDivEl
  * Inside it, the date and time pickers take its `locale` unless given their
  * own, and their week starts on the first day of the locale they use unless
  * `firstDayOfWeek` is set, and a picker with a `locale` of its own is read
- * like a nested provider. The library's portaled content, such as a
- * `Popover` panel, a `Modal` with `portal`, a `Toast` or a `Portal`'s
- * children, keeps the same `dir` and `lang` though it renders outside the
- * wrapper: in a container outside the wrapper, it sits in a
- * `display: contents` element that carries them. Without a provider none of
- * this changes.
+ * like a nested provider. With a `locale`, the numbers the library writes,
+ * such as page numbers and badge counts, follow it, and so does the
+ * filtering in `Combobox`, `Autocomplete`, `Taginput` and `Command`, which then ignores
+ * accents where the language treats letters as the same. The library's
+ * portaled content, such as a `Popover` panel, a `Modal` with `portal`, a
+ * `Toast` or a `Portal`'s children, keeps the same `dir` and `lang` though
+ * it renders outside the wrapper: in a container outside the wrapper, it
+ * sits in a `display: contents` element that carries them. Without a
+ * provider none of this changes.
  *
  * @function
  * @param {LocaleProviderProps} props - Props for the LocaleProvider.

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

@@ -0,0 +1,26 @@
+/** Formats a number for display, with `Intl.NumberFormat` options. */
+export type NumberFormatter = (value: number, options?: Intl.NumberFormatOptions) => string;
+/** Whether `text` contains `query`, as the locale compares letters. */
+export type TextMatcher = (text: string, query: string) => boolean;
+/**
+ * A formatter for numbers shown on screen, in the locale of the
+ * `LocaleProvider` around the component, or `null` outside one that gives a
+ * locale. Formatters are kept per set of options, since building one is the
+ * expensive part.
+ *
+ * @param own - The component's own locale, such as a picker's `locale`,
+ * which wins inside a provider.
+ */
+export declare function useNumberFormat(own?: string): NumberFormatter | null;
+/**
+ * A matcher for filtering a list by what was typed, in the locale of the
+ * `LocaleProvider` around the component, or `null` outside one that gives a
+ * locale. It compares with `Intl.Collator` at `usage: 'search'` and
+ * `sensitivity: 'base'`, so it ignores case and accents where the language
+ * treats the letters as the same: "cafe" finds "Café", while in Swedish "a"
+ * doesn't find "å", a letter of its own there. Marks the language ignores
+ * count for nothing on either side, so in Arabic محمد finds مُحَمَّد and the
+ * other way round. An empty query, or one of nothing but such marks,
+ * matches everything.
+ */
+export declare function useLocaleMatcher(): TextMatcher | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allxsmith/bestax-bulma",
-  "version": "5.53.0",
+  "version": "5.54.0",
   "description": "Component library based on React, Bulma, with Agent Skills and MCP",
   "main": "dist/index.cjs",
   "module": "dist/index.esm.js",