pure-uikit 1.5.21 → 1.6.1

package/cdn/types/vue/index.d.ts

@@ -1,13 +1,13 @@
 import type { DefineComponent } from "vue";
 
 import type { PAlert } from "../../components/alert/alert.component.js";
-import type { PAnimation } from "../../components/animation/animation.component.js";
 import type { PAvatar } from "../../components/avatar/avatar.component.js";
+import type { PBadge } from "../../components/badge/badge.component.js";
 import type { PBreadcrumb } from "../../components/breadcrumb/breadcrumb.component.js";
-import type { PBreadcrumbItem } from "../../components/breadcrumb-item/breadcrumb-item.component.js";
 import type { PAnimatedImage } from "../../components/animated-image/animated-image.component.js";
+import type { PBreadcrumbItem } from "../../components/breadcrumb-item/breadcrumb-item.component.js";
+import type { PAnimation } from "../../components/animation/animation.component.js";
 import type { PButton } from "../../components/button/button.component.js";
-import type { PBadge } from "../../components/badge/badge.component.js";
 import type { PButtonGroup } from "../../components/button-group/button-group.component.js";
 import type { PCalendar } from "../../components/calendar/calendar.component.js";
 import type { PCard } from "../../components/card/card.component.js";
@@ -16,8 +16,8 @@ import type { PCarouselItem } from "../../components/carousel-item/carousel-item
 import type { PCheckbox } from "../../components/checkbox/checkbox.component.js";
 import type { PColorPicker } from "../../components/color-picker/color-picker.component.js";
 import type { PCopyButton } from "../../components/copy-button/copy-button.component.js";
-import type { PDetails } from "../../components/details/details.component.js";
 import type { PDialog } from "../../components/dialog/dialog.component.js";
+import type { PDetails } from "../../components/details/details.component.js";
 import type { PDivider } from "../../components/divider/divider.component.js";
 import type { PDrawer } from "../../components/drawer/drawer.component.js";
 import type { PDropdown } from "../../components/dropdown/dropdown.component.js";
@@ -89,48 +89,6 @@ the alert will not close on its own. */
   "onp-after-hide"?: (e: CustomEvent<never>) => void;
 };
 
-type PAnimationProps = {
-  /** The name of the built-in animation to use. For custom animations, use the `keyframes` prop. */
-  name?: PAnimation["name"];
-  /** Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when
-the animation finishes or gets canceled. */
-  play?: PAnimation["play"];
-  /** The number of milliseconds to delay the start of the animation. */
-  delay?: PAnimation["delay"];
-  /** Determines the direction of playback as well as the behavior when reaching the end of an iteration.
-[Learn more](https://developer.mozilla.org/en-US/docs/Web/CSS/animation-direction) */
-  direction?: PAnimation["direction"];
-  /** The number of milliseconds each iteration of the animation takes to complete. */
-  duration?: PAnimation["duration"];
-  /** The easing function to use for the animation. This can be a Pure UI easing function or a custom easing function
-such as `cubic-bezier(0, 1, .76, 1.14)`. */
-  easing?: PAnimation["easing"];
-  /** The number of milliseconds to delay after the active period of an animation sequence. */
-  "end-delay"?: PAnimation["endDelay"];
-  /** Sets how the animation applies styles to its target before and after its execution. */
-  fill?: PAnimation["fill"];
-  /** The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops. */
-  iterations?: PAnimation["iterations"];
-  /** The offset at which to start the animation, usually between 0 (start) and 1 (end). */
-  "iteration-start"?: PAnimation["iterationStart"];
-  /** Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this
-to `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This
-value can be changed without causing the animation to restart. */
-  "playback-rate"?: PAnimation["playbackRate"];
-  /**  */
-  defaultPot?: PAnimation["defaultPot"];
-  /** The keyframes to use for the animation. If this is set, `name` will be ignored. */
-  keyframes?: PAnimation["keyframes"];
-  /** Gets and sets the current animation time. */
-  currentTime?: PAnimation["currentTime"];
-  /** Emitted when the animation is canceled. */
-  "onp-cancel"?: (e: CustomEvent<never>) => void;
-  /** Emitted when the animation finishes. */
-  "onp-finish"?: (e: CustomEvent<never>) => void;
-  /** Emitted when the animation starts or restarts. */
-  "onp-start"?: (e: CustomEvent<never>) => void;
-};
-
 type PAvatarProps = {
   /** The image source to use for the avatar. */
   image?: PAvatar["image"];
@@ -147,6 +105,15 @@ type PAvatarProps = {
   "onp-error"?: (e: CustomEvent<never>) => void;
 };
 
+type PBadgeProps = {
+  /** The badge's theme variant. */
+  variant?: PBadge["variant"];
+  /** Draws a pill-style badge with rounded edges. */
+  pill?: PBadge["pill"];
+  /** Makes the badge pulsate to draw attention. */
+  pulse?: PBadge["pulse"];
+};
+
 type PBreadcrumbProps = {
   /** The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by
 screen readers and other assistive devices to provide more context for users. */
@@ -157,16 +124,6 @@ screen readers and other assistive devices to provide more context for users. */
   separatorSlot?: PBreadcrumb["separatorSlot"];
 };
 
-type PBreadcrumbItemProps = {
-  /** Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered
-internally. When unset, a button will be rendered instead. */
-  href?: PBreadcrumbItem["href"];
-  /** Tells the browser where to open the link. Only used when `href` is set. */
-  target?: PBreadcrumbItem["target"];
-  /** The `rel` attribute to use on the link. Only used when `href` is set. */
-  rel?: PBreadcrumbItem["rel"];
-};
-
 type PAnimatedImageProps = {
   /** The path to the image to load. */
   src?: PAnimatedImage["src"];
@@ -186,6 +143,58 @@ type PAnimatedImageProps = {
   "onp-error"?: (e: CustomEvent<never>) => void;
 };
 
+type PBreadcrumbItemProps = {
+  /** Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered
+internally. When unset, a button will be rendered instead. */
+  href?: PBreadcrumbItem["href"];
+  /** Tells the browser where to open the link. Only used when `href` is set. */
+  target?: PBreadcrumbItem["target"];
+  /** The `rel` attribute to use on the link. Only used when `href` is set. */
+  rel?: PBreadcrumbItem["rel"];
+};
+
+type PAnimationProps = {
+  /** The name of the built-in animation to use. For custom animations, use the `keyframes` prop. */
+  name?: PAnimation["name"];
+  /** Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when
+the animation finishes or gets canceled. */
+  play?: PAnimation["play"];
+  /** The number of milliseconds to delay the start of the animation. */
+  delay?: PAnimation["delay"];
+  /** Determines the direction of playback as well as the behavior when reaching the end of an iteration.
+[Learn more](https://developer.mozilla.org/en-US/docs/Web/CSS/animation-direction) */
+  direction?: PAnimation["direction"];
+  /** The number of milliseconds each iteration of the animation takes to complete. */
+  duration?: PAnimation["duration"];
+  /** The easing function to use for the animation. This can be a Pure UI easing function or a custom easing function
+such as `cubic-bezier(0, 1, .76, 1.14)`. */
+  easing?: PAnimation["easing"];
+  /** The number of milliseconds to delay after the active period of an animation sequence. */
+  "end-delay"?: PAnimation["endDelay"];
+  /** Sets how the animation applies styles to its target before and after its execution. */
+  fill?: PAnimation["fill"];
+  /** The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops. */
+  iterations?: PAnimation["iterations"];
+  /** The offset at which to start the animation, usually between 0 (start) and 1 (end). */
+  "iteration-start"?: PAnimation["iterationStart"];
+  /** Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this
+to `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This
+value can be changed without causing the animation to restart. */
+  "playback-rate"?: PAnimation["playbackRate"];
+  /**  */
+  defaultPot?: PAnimation["defaultPot"];
+  /** The keyframes to use for the animation. If this is set, `name` will be ignored. */
+  keyframes?: PAnimation["keyframes"];
+  /** Gets and sets the current animation time. */
+  currentTime?: PAnimation["currentTime"];
+  /** Emitted when the animation is canceled. */
+  "onp-cancel"?: (e: CustomEvent<never>) => void;
+  /** Emitted when the animation finishes. */
+  "onp-finish"?: (e: CustomEvent<never>) => void;
+  /** Emitted when the animation starts or restarts. */
+  "onp-start"?: (e: CustomEvent<never>) => void;
+};
+
 type PButtonProps = {
   /**  */
   title?: PButton["title"];
@@ -255,15 +264,6 @@ value of this attribute must be an id of a form in the same document or shadow r
   "onp-invalid"?: (e: CustomEvent<never>) => void;
 };
 
-type PBadgeProps = {
-  /** The badge's theme variant. */
-  variant?: PBadge["variant"];
-  /** Draws a pill-style badge with rounded edges. */
-  pill?: PBadge["pill"];
-  /** Makes the badge pulsate to draw attention. */
-  pulse?: PBadge["pulse"];
-};
-
 type PButtonGroupProps = {
   /** A label to use for the button group. This won't be displayed on the screen, but it will be announced by assistive
 devices when interacting with the control and is strongly recommended. */
@@ -627,34 +627,6 @@ scenarios. */
   "onp-error"?: (e: CustomEvent<never>) => void;
 };
 
-type PDetailsProps = {
-  /** Indicates whether or not the details is open. You can toggle this attribute to show and hide the details, or you
-can use the `show()` and `hide()` methods and this attribute will reflect the details' open state. */
-  open?: PDetails["open"];
-  /** The summary to show in the header. If you need to display HTML, use the `summary` slot instead. */
-  summary?: PDetails["summary"];
-  /** Disables the details so it can't be toggled. */
-  disabled?: PDetails["disabled"];
-  /**  */
-  details?: PDetails["details"];
-  /**  */
-  header?: PDetails["header"];
-  /**  */
-  body?: PDetails["body"];
-  /**  */
-  expandIconSlot?: PDetails["expandIconSlot"];
-  /**  */
-  detailsObserver?: PDetails["detailsObserver"];
-  /** Emitted when the details opens. */
-  "onp-show"?: (e: CustomEvent<never>) => void;
-  /** Emitted after the details opens and all animations are complete. */
-  "onp-after-show"?: (e: CustomEvent<never>) => void;
-  /** Emitted when the details closes. */
-  "onp-hide"?: (e: CustomEvent<never>) => void;
-  /** Emitted after the details closes and all animations are complete. */
-  "onp-after-hide"?: (e: CustomEvent<never>) => void;
-};
-
 type PDialogProps = {
   /** Indicates whether or not the dialog is open. You can toggle this attribute to show and hide the dialog, or you can
 use the `show()` and `hide()` methods and this attribute will reflect the dialog's open state. */
@@ -687,6 +659,34 @@ accessible way for users to dismiss the dialog. */
   "onp-request-close"?: (e: CustomEvent<{ source: "close-button" | "keyboard" | "overlay" }>) => void;
 };
 
+type PDetailsProps = {
+  /** Indicates whether or not the details is open. You can toggle this attribute to show and hide the details, or you
+can use the `show()` and `hide()` methods and this attribute will reflect the details' open state. */
+  open?: PDetails["open"];
+  /** The summary to show in the header. If you need to display HTML, use the `summary` slot instead. */
+  summary?: PDetails["summary"];
+  /** Disables the details so it can't be toggled. */
+  disabled?: PDetails["disabled"];
+  /**  */
+  details?: PDetails["details"];
+  /**  */
+  header?: PDetails["header"];
+  /**  */
+  body?: PDetails["body"];
+  /**  */
+  expandIconSlot?: PDetails["expandIconSlot"];
+  /**  */
+  detailsObserver?: PDetails["detailsObserver"];
+  /** Emitted when the details opens. */
+  "onp-show"?: (e: CustomEvent<never>) => void;
+  /** Emitted after the details opens and all animations are complete. */
+  "onp-after-show"?: (e: CustomEvent<never>) => void;
+  /** Emitted when the details closes. */
+  "onp-hide"?: (e: CustomEvent<never>) => void;
+  /** Emitted after the details closes and all animations are complete. */
+  "onp-after-hide"?: (e: CustomEvent<never>) => void;
+};
+
 type PDividerProps = {
   /** Draws the divider in a vertical orientation. */
   vertical?: PDivider["vertical"];
@@ -1949,25 +1949,6 @@ export type CustomElements = {
    */
   "p-alert": DefineComponent<PAlertProps>;
 
-  /**
-   * Animate elements declaratively with nearly 100 baked-in presets, or roll your own with custom keyframes. Powered by the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).
-   * ---
-   *
-   *
-   * ### **Events:**
-   *  - **p-cancel** - Emitted when the animation is canceled.
-   * - **p-finish** - Emitted when the animation finishes.
-   * - **p-start** - Emitted when the animation starts or restarts.
-   *
-   * ### **Methods:**
-   *  - **cancel()** - Clears all keyframe effects caused by this animation and aborts its playback.
-   * - **finish()** - Sets the playback time to the end of the animation corresponding to the current playback direction.
-   *
-   * ### **Slots:**
-   *  - _default_ - The element to animate. Avoid slotting in more than one element, as subsequent ones will be ignored. To animate multiple elements, either wrap them in a single container or use multiple `<p-animation>` elements.
-   */
-  "p-animation": DefineComponent<PAnimationProps>;
-
   /**
    * Avatars are used to represent a person or object.
    * ---
@@ -1990,6 +1971,19 @@ export type CustomElements = {
    */
   "p-avatar": DefineComponent<PAvatarProps>;
 
+  /**
+   * Badges are used to draw attention and display statuses or counts.
+   * ---
+   *
+   *
+   * ### **Slots:**
+   *  - _default_ - The badge's content.
+   *
+   * ### **CSS Parts:**
+   *  - **base** - The component's base wrapper.
+   */
+  "p-badge": DefineComponent<PBadgeProps>;
+
   /**
    * Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.
    * ---
@@ -2004,6 +1998,28 @@ export type CustomElements = {
    */
   "p-breadcrumb": DefineComponent<PBreadcrumbProps>;
 
+  /**
+   * A component for displaying animated GIFs and WEBPs that play and pause on interaction.
+   * ---
+   *
+   *
+   * ### **Events:**
+   *  - **p-load** - Emitted when the image loads successfully.
+   * - **p-error** - Emitted when the image fails to load.
+   *
+   * ### **Slots:**
+   *  - **play-icon** - Optional play icon to use instead of the default. Works best with `<p-icon>`.
+   * - **pause-icon** - Optional pause icon to use instead of the default. Works best with `<p-icon>`.
+   *
+   * ### **CSS Properties:**
+   *  - **--control-box-size** - The size of the icon box. _(default: undefined)_
+   * - **--icon-size** - The size of the play/pause icons. _(default: undefined)_
+   *
+   * ### **CSS Parts:**
+   *  - **control-box** - The container that surrounds the pause/play icons and provides their background.
+   */
+  "p-animated-image": DefineComponent<PAnimatedImageProps>;
+
   /**
    * Breadcrumb Items are used inside [breadcrumbs](/components/breadcrumb) to represent different links.
    * ---
@@ -2025,26 +2041,23 @@ export type CustomElements = {
   "p-breadcrumb-item": DefineComponent<PBreadcrumbItemProps>;
 
   /**
-   * A component for displaying animated GIFs and WEBPs that play and pause on interaction.
+   * Animate elements declaratively with nearly 100 baked-in presets, or roll your own with custom keyframes. Powered by the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).
    * ---
    *
    *
    * ### **Events:**
-   *  - **p-load** - Emitted when the image loads successfully.
-   * - **p-error** - Emitted when the image fails to load.
-   *
-   * ### **Slots:**
-   *  - **play-icon** - Optional play icon to use instead of the default. Works best with `<p-icon>`.
-   * - **pause-icon** - Optional pause icon to use instead of the default. Works best with `<p-icon>`.
+   *  - **p-cancel** - Emitted when the animation is canceled.
+   * - **p-finish** - Emitted when the animation finishes.
+   * - **p-start** - Emitted when the animation starts or restarts.
    *
-   * ### **CSS Properties:**
-   *  - **--control-box-size** - The size of the icon box. _(default: undefined)_
-   * - **--icon-size** - The size of the play/pause icons. _(default: undefined)_
+   * ### **Methods:**
+   *  - **cancel()** - Clears all keyframe effects caused by this animation and aborts its playback.
+   * - **finish()** - Sets the playback time to the end of the animation corresponding to the current playback direction.
    *
-   * ### **CSS Parts:**
-   *  - **control-box** - The container that surrounds the pause/play icons and provides their background.
+   * ### **Slots:**
+   *  - _default_ - The element to animate. Avoid slotting in more than one element, as subsequent ones will be ignored. To animate multiple elements, either wrap them in a single container or use multiple `<p-animation>` elements.
    */
-  "p-animated-image": DefineComponent<PAnimatedImageProps>;
+  "p-animation": DefineComponent<PAnimationProps>;
 
   /**
    * Buttons represent actions that are available to the user.
@@ -2080,19 +2093,6 @@ export type CustomElements = {
    */
   "p-button": DefineComponent<PButtonProps>;
 
-  /**
-   * Badges are used to draw attention and display statuses or counts.
-   * ---
-   *
-   *
-   * ### **Slots:**
-   *  - _default_ - The badge's content.
-   *
-   * ### **CSS Parts:**
-   *  - **base** - The component's base wrapper.
-   */
-  "p-badge": DefineComponent<PBadgeProps>;
-
   /**
    * Button groups can be used to group related buttons into sections.
    * ---
@@ -2375,36 +2375,6 @@ export type CustomElements = {
    */
   "p-copy-button": DefineComponent<PCopyButtonProps>;
 
-  /**
-   * Details show a brief summary and expand to show additional content.
-   * ---
-   *
-   *
-   * ### **Events:**
-   *  - **p-show** - Emitted when the details opens.
-   * - **p-after-show** - Emitted after the details opens and all animations are complete.
-   * - **p-hide** - Emitted when the details closes.
-   * - **p-after-hide** - Emitted after the details closes and all animations are complete.
-   *
-   * ### **Methods:**
-   *  - **show()** - Shows the details.
-   * - **hide()** - Hides the details
-   *
-   * ### **Slots:**
-   *  - _default_ - The details' main content.
-   * - **summary** - The details' summary. Alternatively, you can use the `summary` attribute.
-   * - **expand-icon** - Optional expand icon to use instead of the default. Works best with `<p-icon>`.
-   * - **collapse-icon** - Optional collapse icon to use instead of the default. Works best with `<p-icon>`.
-   *
-   * ### **CSS Parts:**
-   *  - **base** - The component's base wrapper.
-   * - **header** - The header that wraps both the summary and the expand/collapse icon.
-   * - **summary** - The container that wraps the summary.
-   * - **summary-icon** - The container that wraps the expand/collapse icons.
-   * - **content** - The details content.
-   */
-  "p-details": DefineComponent<PDetailsProps>;
-
   /**
    * Dialogs, sometimes called "modals", appear above the page and require the user's immediate attention.
    * ---
@@ -2448,6 +2418,36 @@ export type CustomElements = {
    */
   "p-dialog": DefineComponent<PDialogProps>;
 
+  /**
+   * Details show a brief summary and expand to show additional content.
+   * ---
+   *
+   *
+   * ### **Events:**
+   *  - **p-show** - Emitted when the details opens.
+   * - **p-after-show** - Emitted after the details opens and all animations are complete.
+   * - **p-hide** - Emitted when the details closes.
+   * - **p-after-hide** - Emitted after the details closes and all animations are complete.
+   *
+   * ### **Methods:**
+   *  - **show()** - Shows the details.
+   * - **hide()** - Hides the details
+   *
+   * ### **Slots:**
+   *  - _default_ - The details' main content.
+   * - **summary** - The details' summary. Alternatively, you can use the `summary` attribute.
+   * - **expand-icon** - Optional expand icon to use instead of the default. Works best with `<p-icon>`.
+   * - **collapse-icon** - Optional collapse icon to use instead of the default. Works best with `<p-icon>`.
+   *
+   * ### **CSS Parts:**
+   *  - **base** - The component's base wrapper.
+   * - **header** - The header that wraps both the summary and the expand/collapse icon.
+   * - **summary** - The container that wraps the summary.
+   * - **summary-icon** - The container that wraps the expand/collapse icons.
+   * - **content** - The details content.
+   */
+  "p-details": DefineComponent<PDetailsProps>;
+
   /**
    * Dividers are used to visually separate or group elements.
    * ---