@allxsmith/bestax-bulma 5.44.0 → 5.45.0

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

@@ -134,9 +134,31 @@ export interface CarouselProps extends Omit<React.HTMLAttributes<HTMLDivElement>
      * a carousel inside a form is not submitted by picking a slide.
      */
     indicator?: boolean;
-    /** Position indicators inside carousel. */
+    /**
+     * Puts the indicators over the slides instead of below them, at the edge
+     * `indicatorPosition` names. It also turns on the overlay look unless
+     * `overlayControls` says otherwise, so on its own it gives the look made
+     * for photos: light arrows, and light indicators on a dark gradient band.
+     */
     indicatorInside?: boolean;
-    /** Indicator position. Default: 'bottom'. */
+    /**
+     * The overlay look, made for photos. The arrows take the
+     * `--bulma-carousel-overlay-arrow-*` colors, and indicators over the
+     * slides take the `--bulma-carousel-overlay-indicator-*` colors on a dark
+     * gradient band. Indicators below the slides keep their plain colors,
+     * since they sit on the page. It follows `indicatorInside` unless you set
+     * it, so `overlayControls={false}` puts the indicators over the slides
+     * with the plain look, and `overlayControls` alone gives the arrows the
+     * overlay look with the indicators below. While it's on, `arrowColor`
+     * doesn't apply.
+     * @defaultValue indicatorInside
+     */
+    overlayControls?: boolean;
+    /**
+     * The edge of the slides `indicatorInside` puts the indicators on.
+     * Default: 'bottom'. Without `indicatorInside` they sit below the slides
+     * whatever this says, so leave it unset there.
+     */
     indicatorPosition?: 'bottom' | 'top';
     /** Indicator style. Default: 'dots'. */
     indicatorStyle?: 'circles' | 'dots' | 'lines' | 'bars';
@@ -154,7 +176,11 @@ export interface CarouselProps extends Omit<React.HTMLAttributes<HTMLDivElement>
     iconFeatures?: string | string[];
     /** Show semi-transparent background on arrow buttons. Set to `false` for icon-only arrows. */
     arrowBackground?: boolean;
-    /** Color theme for navigation arrows. */
+    /**
+     * Color theme for navigation arrows. Not applied while the overlay look is
+     * on (see `overlayControls`, which `indicatorInside` turns on), whose
+     * arrows take `--bulma-carousel-overlay-arrow-color`.
+     */
     arrowColor?: 'light' | 'dark';
     /** Accessible label for the carousel region. Default: 'Image carousel'. */
     ariaLabel?: string;

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

@@ -47,12 +47,14 @@ export interface CheckboxProps extends Omit<React.InputHTMLAttributes<HTMLInputE
     /**
      * 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.
+     * still the value, and a click still toggles `checked`. Set to `true` or
+     * `false`, it's controlled: a browser clears the mixed state on a click,
+     * so the component sets it again from this prop after every click and
+     * every render. Unset isn't `false`. The component leaves the input's own
+     * `indeterminate` property alone, so a ref can set it, and going from set
+     * 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;
     /**

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

@@ -134,9 +134,31 @@ export interface CarouselProps extends Omit<React.HTMLAttributes<HTMLDivElement>
      * a carousel inside a form is not submitted by picking a slide.
      */
     indicator?: boolean;
-    /** Position indicators inside carousel. */
+    /**
+     * Puts the indicators over the slides instead of below them, at the edge
+     * `indicatorPosition` names. It also turns on the overlay look unless
+     * `overlayControls` says otherwise, so on its own it gives the look made
+     * for photos: light arrows, and light indicators on a dark gradient band.
+     */
     indicatorInside?: boolean;
-    /** Indicator position. Default: 'bottom'. */
+    /**
+     * The overlay look, made for photos. The arrows take the
+     * `--bulma-carousel-overlay-arrow-*` colors, and indicators over the
+     * slides take the `--bulma-carousel-overlay-indicator-*` colors on a dark
+     * gradient band. Indicators below the slides keep their plain colors,
+     * since they sit on the page. It follows `indicatorInside` unless you set
+     * it, so `overlayControls={false}` puts the indicators over the slides
+     * with the plain look, and `overlayControls` alone gives the arrows the
+     * overlay look with the indicators below. While it's on, `arrowColor`
+     * doesn't apply.
+     * @defaultValue indicatorInside
+     */
+    overlayControls?: boolean;
+    /**
+     * The edge of the slides `indicatorInside` puts the indicators on.
+     * Default: 'bottom'. Without `indicatorInside` they sit below the slides
+     * whatever this says, so leave it unset there.
+     */
     indicatorPosition?: 'bottom' | 'top';
     /** Indicator style. Default: 'dots'. */
     indicatorStyle?: 'circles' | 'dots' | 'lines' | 'bars';
@@ -154,7 +176,11 @@ export interface CarouselProps extends Omit<React.HTMLAttributes<HTMLDivElement>
     iconFeatures?: string | string[];
     /** Show semi-transparent background on arrow buttons. Set to `false` for icon-only arrows. */
     arrowBackground?: boolean;
-    /** Color theme for navigation arrows. */
+    /**
+     * Color theme for navigation arrows. Not applied while the overlay look is
+     * on (see `overlayControls`, which `indicatorInside` turns on), whose
+     * arrows take `--bulma-carousel-overlay-arrow-color`.
+     */
     arrowColor?: 'light' | 'dark';
     /** Accessible label for the carousel region. Default: 'Image carousel'. */
     ariaLabel?: string;

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

@@ -47,12 +47,14 @@ export interface CheckboxProps extends Omit<React.InputHTMLAttributes<HTMLInputE
     /**
      * 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.
+     * still the value, and a click still toggles `checked`. Set to `true` or
+     * `false`, it's controlled: a browser clears the mixed state on a click,
+     * so the component sets it again from this prop after every click and
+     * every render. Unset isn't `false`. The component leaves the input's own
+     * `indeterminate` property alone, so a ref can set it, and going from set
+     * 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;
     /**