@allxsmith/bestax-bulma 5.45.0 → 5.45.1

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

@@ -9,7 +9,14 @@ export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     active?: boolean;
     /** Alias for `active`. Whether the modal is open/visible. */
     isActive?: boolean;
-    /** Callback invoked to request modal close (background or close button). */
+    /**
+     * Called to ask for the modal to close. The props form calls it from the
+     * background and the close button it renders. In the compound form,
+     * `Modal.Close` calls it unless you give it an `onClick` of your own, and
+     * `Modal.Background` doesn't call it on its own: pass it
+     * `onClick={onClose}` for a click on the background to close the modal.
+     * Escape calls it in both forms unless `closeOnEscape` is `false`.
+     */
     onClose?: () => void;
     /** Additional CSS classes for the modal. */
     className?: string;
@@ -61,6 +68,7 @@ export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
 }
 /**
  * Props for Modal.Background component.
+ * @extraProp {React.MouseEventHandler<HTMLDivElement>} [onClick] - Called when the background is clicked. The background doesn't call the modal's `onClose` on its own, so pass `onClick={onClose}` for a click on it to close the modal.
  */
 export interface ModalBackgroundProps extends React.HTMLAttributes<HTMLDivElement> {
     /** Additional CSS classes. */
@@ -112,6 +120,7 @@ export interface ModalCardFootProps extends React.HTMLAttributes<HTMLElement> {
  * Props for Modal.Close component.
  * @extraProp {'button' | 'submit' | 'reset'} [type='button'] - Button type. Defaults to `'button'`, so a close button inside a form does not submit it. Pass `'submit'` or `'reset'` and yours is used; any other value, or a spread carrying `type: undefined`, renders `'button'`.
  * @extraProp {string} [aria-label='close'] - Accessible name. Pass your own to replace it. An empty one, or a spread carrying `'aria-label': undefined`, keeps the default rather than leaving the button unnamed.
+ * @extraProp {React.MouseEventHandler<HTMLButtonElement>} [onClick] - Called when the button is clicked. Without one, the button calls the `onClose` of the `Modal` around it. Yours replaces that rather than running before it, so call `onClose` from it if the button should still close the modal.
  */
 export interface ModalCloseProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
     /** Additional CSS classes. */

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

@@ -9,7 +9,14 @@ export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     active?: boolean;
     /** Alias for `active`. Whether the modal is open/visible. */
     isActive?: boolean;
-    /** Callback invoked to request modal close (background or close button). */
+    /**
+     * Called to ask for the modal to close. The props form calls it from the
+     * background and the close button it renders. In the compound form,
+     * `Modal.Close` calls it unless you give it an `onClick` of your own, and
+     * `Modal.Background` doesn't call it on its own: pass it
+     * `onClick={onClose}` for a click on the background to close the modal.
+     * Escape calls it in both forms unless `closeOnEscape` is `false`.
+     */
     onClose?: () => void;
     /** Additional CSS classes for the modal. */
     className?: string;
@@ -61,6 +68,7 @@ export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
 }
 /**
  * Props for Modal.Background component.
+ * @extraProp {React.MouseEventHandler<HTMLDivElement>} [onClick] - Called when the background is clicked. The background doesn't call the modal's `onClose` on its own, so pass `onClick={onClose}` for a click on it to close the modal.
  */
 export interface ModalBackgroundProps extends React.HTMLAttributes<HTMLDivElement> {
     /** Additional CSS classes. */
@@ -112,6 +120,7 @@ export interface ModalCardFootProps extends React.HTMLAttributes<HTMLElement> {
  * Props for Modal.Close component.
  * @extraProp {'button' | 'submit' | 'reset'} [type='button'] - Button type. Defaults to `'button'`, so a close button inside a form does not submit it. Pass `'submit'` or `'reset'` and yours is used; any other value, or a spread carrying `type: undefined`, renders `'button'`.
  * @extraProp {string} [aria-label='close'] - Accessible name. Pass your own to replace it. An empty one, or a spread carrying `'aria-label': undefined`, keeps the default rather than leaving the button unnamed.
+ * @extraProp {React.MouseEventHandler<HTMLButtonElement>} [onClick] - Called when the button is clicked. Without one, the button calls the `onClose` of the `Modal` around it. Yours replaces that rather than running before it, so call `onClose` from it if the button should still close the modal.
  */
 export interface ModalCloseProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
     /** Additional CSS classes. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allxsmith/bestax-bulma",
-  "version": "5.45.0",
+  "version": "5.45.1",
   "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",