@esri/calcite-components 1.0.0-next.478 → 1.0.0-next.479

package/dist/types/components.d.ts

@@ -1985,111 +1985,111 @@ export namespace Components {
     }
     interface CalciteModal {
         /**
-          * Add the active attribute to open the modal
+          * When true, the `calcite-modal` is active.
          */
         "active": boolean;
         /**
-          * Background color of modal content
+          * Sets the background color of `calcite-modal` content.
          */
         "backgroundColor": ModalBackgroundColor;
         /**
-          * Optionally pass a function to run before close
+          * Passes a function to run before the `calcite-modal` closes.
          */
-        "beforeClose": (el: HTMLElement) => Promise<void>;
+        "beforeClose"?: (el: HTMLElement) => Promise<void>;
         /**
-          * Adds a color bar at the top for visual impact, Use color to add importance to destructive/workflow dialogs.
+          * Adds a color bar to the top of `calcite-modal` for visual impact. Use color to add importance to destructive or workflow dialogs.
          */
         "color"?: "red" | "blue";
         /**
-          * Disables the display a close button within the Modal
+          * When true, disables the close button within the `calcite-modal`.
          */
         "disableCloseButton": boolean;
         /**
-          * Flag to disable the default close on escape behavior
+          * When true, disables the default close on escape behavior.
          */
         "disableEscape": boolean;
         /**
-          * Disables the closing of the Modal when clicked outside.
+          * When true, disables the closing of the `calcite-modal` when clicked outside.
          */
         "disableOutsideClose": boolean;
         /**
-          * Prevent the modal from taking up the entire screen on mobile
+          * When true, prevents the `calcite-modal` from expanding to the entire screen on mobile devices.
          */
         "docked": boolean;
         /**
-          * Specify an element to focus when the modal is first opened
+          * Specify the initial focus when the `calcite-modal` is first opened.
          */
-        "firstFocus"?: HTMLElement;
+        "firstFocus": HTMLElement;
         /**
-          * Focus first interactive element
+          * Focus the first interactive element.
           * @param el
           * @deprecated use `setFocus` instead.
          */
         "focusElement": (el?: HTMLElement) => Promise<void>;
         /**
-          * Set the modal to always be fullscreen (overrides width)
+          * Set the `calcite-modal` to always be fullscreen (overrides width).
          */
         "fullscreen": boolean;
         /**
-          * Aria label for the close button
+          * Accessible label for the close button.
          */
         "intlClose": string;
         /**
-          * Turn off spacing around the content area slot
+          * When true, disables spacing to the content area slot.
          */
         "noPadding": boolean;
         /**
-          * specify the scale of modal, defaults to m
+          * Specify the scale of `calcite-modal`.
          */
         "scale": Scale;
         /**
-          * Set the scroll top of the modal content
+          * Set the scroll top of the `calcite-modal` content.
           * @param top
           * @param left
          */
         "scrollContent": (top?: number, left?: number) => Promise<void>;
         /**
-          * Sets focus on the component.  By default, will try to focus on any focusable content. If there is none, it will focus on the close button. If you want to focus on the close button, you can use the `close-button` focus ID.
+          * Sets focus on the component.  By default, tries to focus on focusable content. If there is none, it will focus on the close button. To focus on the close button, use the `close-button` focus ID.
           * @param focusId
          */
         "setFocus": (focusId?: "close-button") => Promise<void>;
         /**
-          * Set the width of the modal. Can use stock sizes or pass a number (in pixels)
+          * Set the width of the `calcite-modal`. Can use scale sizes or pass a number (displays in pixels).
          */
         "width": Scale | number;
     }
     interface CalciteNotice {
         /**
-          * Is the notice currently active or not
+          * When true, the `calcite-notice` is active.
          */
         "active": boolean;
         /**
-          * Color for the notice (will apply to top border and icon)
+          * The color for the `calcite-notice`. Color will apply to top border and icon.
          */
         "color": StatusColor;
         /**
-          * Optionally show a button the user can click to dismiss the notice
+          * Shows a button the user can click to dismiss the `calcite-notice`.
          */
-        "dismissible": boolean;
+        "dismissible"?: boolean;
         /**
-          * when used as a boolean set to true, show a default recommended icon. You can also pass a calcite-ui-icon name to this prop to display a requested icon
+          * When present, shows a default recommended icon. You can also pass a calcite-ui-icon name to display a requested icon.
          */
         "icon": string | boolean;
         /**
-          * String for the close button.
+          * Accessible label for the close button.
           * @default "Close"
          */
         "intlClose": string;
         /**
-          * specify the scale of the notice, defaults to m
+          * Specify the scale of `calcite-notice`.
          */
         "scale": Scale;
         /**
-          * Sets focus on the component.
+          * Sets focus on the `calcite-notice`.
          */
         "setFocus": () => Promise<void>;
         /**
-          * specify the width of the notice, defaults to auto
+          * Specify the width of the `calcite-notice`.
          */
         "width": Width;
     }
@@ -6154,106 +6154,106 @@ declare namespace LocalJSX {
     }
     interface CalciteModal {
         /**
-          * Add the active attribute to open the modal
+          * When true, the `calcite-modal` is active.
          */
         "active"?: boolean;
         /**
-          * Background color of modal content
+          * Sets the background color of `calcite-modal` content.
          */
         "backgroundColor"?: ModalBackgroundColor;
         /**
-          * Optionally pass a function to run before close
+          * Passes a function to run before the `calcite-modal` closes.
          */
         "beforeClose"?: (el: HTMLElement) => Promise<void>;
         /**
-          * Adds a color bar at the top for visual impact, Use color to add importance to destructive/workflow dialogs.
+          * Adds a color bar to the top of `calcite-modal` for visual impact. Use color to add importance to destructive or workflow dialogs.
          */
         "color"?: "red" | "blue";
         /**
-          * Disables the display a close button within the Modal
+          * When true, disables the close button within the `calcite-modal`.
          */
         "disableCloseButton"?: boolean;
         /**
-          * Flag to disable the default close on escape behavior
+          * When true, disables the default close on escape behavior.
          */
         "disableEscape"?: boolean;
         /**
-          * Disables the closing of the Modal when clicked outside.
+          * When true, disables the closing of the `calcite-modal` when clicked outside.
          */
         "disableOutsideClose"?: boolean;
         /**
-          * Prevent the modal from taking up the entire screen on mobile
+          * When true, prevents the `calcite-modal` from expanding to the entire screen on mobile devices.
          */
         "docked"?: boolean;
         /**
-          * Specify an element to focus when the modal is first opened
+          * Specify the initial focus when the `calcite-modal` is first opened.
          */
         "firstFocus"?: HTMLElement;
         /**
-          * Set the modal to always be fullscreen (overrides width)
+          * Set the `calcite-modal` to always be fullscreen (overrides width).
          */
         "fullscreen"?: boolean;
         /**
-          * Aria label for the close button
+          * Accessible label for the close button.
          */
         "intlClose"?: string;
         /**
-          * Turn off spacing around the content area slot
+          * When true, disables spacing to the content area slot.
          */
         "noPadding"?: boolean;
         /**
-          * Fired when the modal finishes the close animation
+          * Emits when `calcite-modal` finishes the close animation.
          */
         "onCalciteModalClose"?: (event: CustomEvent<any>) => void;
         /**
-          * Fired when the modal finishes the open animation
+          * Emits when `calcite-modal` finishes the open animation.
          */
         "onCalciteModalOpen"?: (event: CustomEvent<any>) => void;
         /**
-          * specify the scale of modal, defaults to m
+          * Specify the scale of `calcite-modal`.
          */
         "scale"?: Scale;
         /**
-          * Set the width of the modal. Can use stock sizes or pass a number (in pixels)
+          * Set the width of the `calcite-modal`. Can use scale sizes or pass a number (displays in pixels).
          */
         "width"?: Scale | number;
     }
     interface CalciteNotice {
         /**
-          * Is the notice currently active or not
+          * When true, the `calcite-notice` is active.
          */
         "active"?: boolean;
         /**
-          * Color for the notice (will apply to top border and icon)
+          * The color for the `calcite-notice`. Color will apply to top border and icon.
          */
         "color"?: StatusColor;
         /**
-          * Optionally show a button the user can click to dismiss the notice
+          * Shows a button the user can click to dismiss the `calcite-notice`.
          */
         "dismissible"?: boolean;
         /**
-          * when used as a boolean set to true, show a default recommended icon. You can also pass a calcite-ui-icon name to this prop to display a requested icon
+          * When present, shows a default recommended icon. You can also pass a calcite-ui-icon name to display a requested icon.
          */
         "icon"?: string | boolean;
         /**
-          * String for the close button.
+          * Accessible label for the close button.
           * @default "Close"
          */
         "intlClose"?: string;
         /**
-          * Fired when an notice is closed
+          * Fired when `calcite-notice` is closed.
          */
         "onCalciteNoticeClose"?: (event: CustomEvent<any>) => void;
         /**
-          * Fired when an Notice is opened
+          * Fired when `calcite-notice` is opened.
          */
         "onCalciteNoticeOpen"?: (event: CustomEvent<any>) => void;
         /**
-          * specify the scale of the notice, defaults to m
+          * Specify the scale of `calcite-notice`.
          */
         "scale"?: Scale;
         /**
-          * specify the width of the notice, defaults to auto
+          * Specify the width of the `calcite-notice`.
          */
         "width"?: Width;
     }