pure-uikit 1.2.2 → 1.2.4

package/dist/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 { PAvatar } from "../../components/avatar/avatar.component.js";
-import type { PBadge } from "../../components/badge/badge.component.js";
 import type { PAnimation } from "../../components/animation/animation.component.js";
 import type { PAnimatedImage } from "../../components/animated-image/animated-image.component.js";
-import type { PBreadcrumb } from "../../components/breadcrumb/breadcrumb.component.js";
+import type { PAvatar } from "../../components/avatar/avatar.component.js";
+import type { PBadge } from "../../components/badge/badge.component.js";
 import type { PBreadcrumbItem } from "../../components/breadcrumb-item/breadcrumb-item.component.js";
 import type { PButton } from "../../components/button/button.component.js";
+import type { PBreadcrumb } from "../../components/breadcrumb/breadcrumb.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";
@@ -33,8 +33,8 @@ import type { PInclude } from "../../components/include/include.component.js";
 import type { PInput } from "../../components/input/input.component.js";
 import type { PMenu } from "../../components/menu/menu.component.js";
 import type { PMenuItem } from "../../components/menu-item/menu-item.component.js";
-import type { PMenuLabel } from "../../components/menu-label/menu-label.component.js";
 import type { PMutationObserver } from "../../components/mutation-observer/mutation-observer.component.js";
+import type { PMenuLabel } from "../../components/menu-label/menu-label.component.js";
 import type { POption } from "../../components/option/option.component.js";
 import type { PPaginate } from "../../components/paginate/paginate.component.js";
 import type { PPopup } from "../../components/popup/popup.component.js";
@@ -55,8 +55,8 @@ import type { PSplitPanel } from "../../components/split-panel/split-panel.compo
 import type { PSwitch } from "../../components/switch/switch.component.js";
 import type { PTab } from "../../components/tab/tab.component.js";
 import type { PTabGroup } from "../../components/tab-group/tab-group.component.js";
-import type { PTable } from "../../components/table/table.component.js";
 import type { PTabPanel } from "../../components/tab-panel/tab-panel.component.js";
+import type { PTable } from "../../components/table/table.component.js";
 import type { PTag } from "../../components/tag/tag.component.js";
 import type { PTextarea } from "../../components/textarea/textarea.component.js";
 import type { PTooltip } from "../../components/tooltip/tooltip.component.js";
@@ -88,31 +88,6 @@ the alert will not close on its own. */
   "onp-after-hide"?: (e: CustomEvent<never>) => void;
 };
 
-type PAvatarProps = {
-  /** The image source to use for the avatar. */
-  image?: PAvatar["image"];
-  /** A label to use to describe the avatar to assistive devices. */
-  label?: PAvatar["label"];
-  /** Initials to use as a fallback when no image is available (1-2 characters max recommended). */
-  initials?: PAvatar["initials"];
-  /** Indicates how the browser should load the image. */
-  loading?: PAvatar["loading"];
-  /** The shape of the avatar. */
-  shape?: PAvatar["shape"];
-
-  /** The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause. */
-  "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 PAnimationProps = {
   /** The name of the built-in animation to use. For custom animations, use the `keyframes` prop. */
   name?: PAnimation["name"];
@@ -174,14 +149,29 @@ type PAnimatedImageProps = {
   "onp-error"?: (e: CustomEvent<never>) => void;
 };
 
-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. */
-  label?: PBreadcrumb["label"];
-  /**  */
-  defaultSlot?: PBreadcrumb["defaultSlot"];
-  /**  */
-  separatorSlot?: PBreadcrumb["separatorSlot"];
+type PAvatarProps = {
+  /** The image source to use for the avatar. */
+  image?: PAvatar["image"];
+  /** A label to use to describe the avatar to assistive devices. */
+  label?: PAvatar["label"];
+  /** Initials to use as a fallback when no image is available (1-2 characters max recommended). */
+  initials?: PAvatar["initials"];
+  /** Indicates how the browser should load the image. */
+  loading?: PAvatar["loading"];
+  /** The shape of the avatar. */
+  shape?: PAvatar["shape"];
+
+  /** The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause. */
+  "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 PBreadcrumbItemProps = {
@@ -263,6 +253,16 @@ 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 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. */
+  label?: PBreadcrumb["label"];
+  /**  */
+  defaultSlot?: PBreadcrumb["defaultSlot"];
+  /**  */
+  separatorSlot?: PBreadcrumb["separatorSlot"];
+};
+
 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. */
@@ -1107,8 +1107,6 @@ type PMenuItemProps = {
   menuItem?: PMenuItem["menuItem"];
 };
 
-type PMenuLabelProps = {};
-
 type PMutationObserverProps = {
   /** Watches for changes to attributes. To watch only specific attributes, separate them by a space, e.g.
 `attr="class id title"`. To watch all attributes, use `*`. */
@@ -1128,6 +1126,8 @@ type PMutationObserverProps = {
   "onp-mutation"?: (e: CustomEvent<{ mutationList: MutationRecord[] }>) => void;
 };
 
+type PMenuLabelProps = {};
+
 type POptionProps = {
   /** When true, the option is hidden from view.
 
@@ -1670,6 +1670,13 @@ manual, the tab will receive focus but will not show until the user presses spac
   "onp-tab-hide"?: (e: CustomEvent<{ name: String }>) => void;
 };
 
+type PTabPanelProps = {
+  /** The tab panel's name. */
+  name?: PTabPanel["name"];
+  /** When true, the tab panel will be shown. */
+  active?: PTabPanel["active"];
+};
+
 type PTableProps = {
   /** Indicates that the element is disabled. */
   disabled?: PTable["disabled"];
@@ -1707,13 +1714,6 @@ If the table is not local paginated, all items are returned. */
   "onp-table-row-select"?: (e: CustomEvent<never>) => void;
 };
 
-type PTabPanelProps = {
-  /** The tab panel's name. */
-  name?: PTabPanel["name"];
-  /** When true, the tab panel will be shown. */
-  active?: PTabPanel["active"];
-};
-
 type PTagProps = {
   /** The tag's theme variant. */
   variant?: PTag["variant"];
@@ -1926,41 +1926,6 @@ export type CustomElements = {
    */
   "p-alert": DefineComponent<PAlertProps>;
 
-  /**
-   * Avatars are used to represent a person or object.
-   * ---
-   *
-   *
-   * ### **Events:**
-   *  - **p-error** - The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause.
-   *
-   * ### **Slots:**
-   *  - **icon** - The default icon to use when no image or initials are present. Works best with `<p-icon>`.
-   *
-   * ### **CSS Properties:**
-   *  - **--size** - The size of the avatar. _(default: undefined)_
-   *
-   * ### **CSS Parts:**
-   *  - **base** - The component's base wrapper.
-   * - **icon** - The container that wraps the avatar's icon.
-   * - **initials** - The container that wraps the avatar's initials.
-   * - **image** - The avatar image. Only shown when the `image` attribute is set.
-   */
-  "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>;
-
   /**
    * 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).
    * ---
@@ -2003,18 +1968,39 @@ export type CustomElements = {
   "p-animated-image": DefineComponent<PAnimatedImageProps>;
 
   /**
-   * Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.
+   * Avatars are used to represent a person or object.
    * ---
    *
    *
+   * ### **Events:**
+   *  - **p-error** - The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause.
+   *
    * ### **Slots:**
-   *  - _default_ - One or more breadcrumb items to display.
-   * - **separator** - The separator to use between breadcrumb items. Works best with `<p-icon>`.
+   *  - **icon** - The default icon to use when no image or initials are present. Works best with `<p-icon>`.
+   *
+   * ### **CSS Properties:**
+   *  - **--size** - The size of the avatar. _(default: undefined)_
    *
    * ### **CSS Parts:**
    *  - **base** - The component's base wrapper.
+   * - **icon** - The container that wraps the avatar's icon.
+   * - **initials** - The container that wraps the avatar's initials.
+   * - **image** - The avatar image. Only shown when the `image` attribute is set.
    */
-  "p-breadcrumb": DefineComponent<PBreadcrumbProps>;
+  "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>;
 
   /**
    * Breadcrumb Items are used inside [breadcrumbs](/components/breadcrumb) to represent different links.
@@ -2070,6 +2056,20 @@ export type CustomElements = {
    */
   "p-button": DefineComponent<PButtonProps>;
 
+  /**
+   * Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.
+   * ---
+   *
+   *
+   * ### **Slots:**
+   *  - _default_ - One or more breadcrumb items to display.
+   * - **separator** - The separator to use between breadcrumb items. Works best with `<p-icon>`.
+   *
+   * ### **CSS Parts:**
+   *  - **base** - The component's base wrapper.
+   */
+  "p-breadcrumb": DefineComponent<PBreadcrumbProps>;
+
   /**
    * Button groups can be used to group related buttons into sections.
    * ---
@@ -2759,30 +2759,30 @@ export type CustomElements = {
   "p-menu-item": DefineComponent<PMenuItemProps>;
 
   /**
-   * Menu labels are used to describe a group of menu items.
+   * The Mutation Observer component offers a thin, declarative interface to the [`MutationObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver).
    * ---
    *
    *
-   * ### **Slots:**
-   *  - _default_ - The menu label's content.
+   * ### **Events:**
+   *  - **p-mutation** - Emitted when a mutation occurs.
    *
-   * ### **CSS Parts:**
-   *  - **base** - The component's base wrapper.
+   * ### **Slots:**
+   *  - _default_ - The content to watch for mutations.
    */
-  "p-menu-label": DefineComponent<PMenuLabelProps>;
+  "p-mutation-observer": DefineComponent<PMutationObserverProps>;
 
   /**
-   * The Mutation Observer component offers a thin, declarative interface to the [`MutationObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver).
+   * Menu labels are used to describe a group of menu items.
    * ---
    *
    *
-   * ### **Events:**
-   *  - **p-mutation** - Emitted when a mutation occurs.
-   *
    * ### **Slots:**
-   *  - _default_ - The content to watch for mutations.
+   *  - _default_ - The menu label's content.
+   *
+   * ### **CSS Parts:**
+   *  - **base** - The component's base wrapper.
    */
-  "p-mutation-observer": DefineComponent<PMutationObserverProps>;
+  "p-menu-label": DefineComponent<PMenuLabelProps>;
 
   /**
    * Options define the selectable items within various form controls such as [select](/components/select).
@@ -3281,6 +3281,22 @@ export type CustomElements = {
    */
   "p-tab-group": DefineComponent<PTabGroupProps>;
 
+  /**
+   * Tab panels are used inside [tab groups](/components/tab-group) to display tabbed content.
+   * ---
+   *
+   *
+   * ### **Slots:**
+   *  - _default_ - The tab panel's content.
+   *
+   * ### **CSS Properties:**
+   *  - **--padding** - The tab panel's padding. _(default: undefined)_
+   *
+   * ### **CSS Parts:**
+   *  - **base** - The component's base wrapper.
+   */
+  "p-tab-panel": DefineComponent<PTabPanelProps>;
+
   /**
    * The Table component is used to display data in a table format.
    * ---
@@ -3326,22 +3342,6 @@ export type CustomElements = {
    */
   "p-table": DefineComponent<PTableProps>;
 
-  /**
-   * Tab panels are used inside [tab groups](/components/tab-group) to display tabbed content.
-   * ---
-   *
-   *
-   * ### **Slots:**
-   *  - _default_ - The tab panel's content.
-   *
-   * ### **CSS Properties:**
-   *  - **--padding** - The tab panel's padding. _(default: undefined)_
-   *
-   * ### **CSS Parts:**
-   *  - **base** - The component's base wrapper.
-   */
-  "p-tab-panel": DefineComponent<PTabPanelProps>;
-
   /**
    * Tags are used as labels to organize things or to indicate a selection.
    * ---

package/dist/vscode.html-custom-data.json

@@ -107,6 +107,33 @@
         }
       ]
     },
+    {
+      "name": "p-animated-image",
+      "description": "A component for displaying animated GIFs and WEBPs that play and pause on interaction.\n---\n\n\n### **Events:**\n - **p-load** - Emitted when the image loads successfully.\n- **p-error** - Emitted when the image fails to load.\n\n### **Slots:**\n - **play-icon** - Optional play icon to use instead of the default. Works best with `<p-icon>`.\n- **pause-icon** - Optional pause icon to use instead of the default. Works best with `<p-icon>`.\n\n### **CSS Properties:**\n - **--control-box-size** - The size of the icon box. _(default: undefined)_\n- **--icon-size** - The size of the play/pause icons. _(default: undefined)_\n\n### **CSS Parts:**\n - **control-box** - The container that surrounds the pause/play icons and provides their background.",
+      "attributes": [
+        {
+          "name": "src",
+          "description": "The path to the image to load.",
+          "values": []
+        },
+        {
+          "name": "alt",
+          "description": "A description of the image used by assistive devices.",
+          "values": []
+        },
+        {
+          "name": "play",
+          "description": "Plays the animation. When this attribute is remove, the animation will pause.",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://pureui.xyz/components/animated-image"
+        }
+      ]
+    },
     {
       "name": "p-avatar",
       "description": "Avatars are used to represent a person or object.\n---\n\n\n### **Events:**\n - **p-error** - The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause.\n\n### **Slots:**\n - **icon** - The default icon to use when no image or initials are present. Works best with `<p-icon>`.\n\n### **CSS Properties:**\n - **--size** - The size of the avatar. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **icon** - The container that wraps the avatar's icon.\n- **initials** - The container that wraps the avatar's initials.\n- **image** - The avatar image. Only shown when the `image` attribute is set.",
@@ -148,33 +175,6 @@
         }
       ]
     },
-    {
-      "name": "p-animated-image",
-      "description": "A component for displaying animated GIFs and WEBPs that play and pause on interaction.\n---\n\n\n### **Events:**\n - **p-load** - Emitted when the image loads successfully.\n- **p-error** - Emitted when the image fails to load.\n\n### **Slots:**\n - **play-icon** - Optional play icon to use instead of the default. Works best with `<p-icon>`.\n- **pause-icon** - Optional pause icon to use instead of the default. Works best with `<p-icon>`.\n\n### **CSS Properties:**\n - **--control-box-size** - The size of the icon box. _(default: undefined)_\n- **--icon-size** - The size of the play/pause icons. _(default: undefined)_\n\n### **CSS Parts:**\n - **control-box** - The container that surrounds the pause/play icons and provides their background.",
-      "attributes": [
-        {
-          "name": "src",
-          "description": "The path to the image to load.",
-          "values": []
-        },
-        {
-          "name": "alt",
-          "description": "A description of the image used by assistive devices.",
-          "values": []
-        },
-        {
-          "name": "play",
-          "description": "Plays the animation. When this attribute is remove, the animation will pause.",
-          "values": []
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://pureui.xyz/components/animated-image"
-        }
-      ]
-    },
     {
       "name": "p-badge",
       "description": "Badges are used to draw attention and display statuses or counts.\n---\n\n\n### **Slots:**\n - _default_ - The badge's content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
@@ -208,23 +208,6 @@
         }
       ]
     },
-    {
-      "name": "p-breadcrumb",
-      "description": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n---\n\n\n### **Slots:**\n - _default_ - One or more breadcrumb items to display.\n- **separator** - The separator to use between breadcrumb items. Works best with `<p-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
-      "attributes": [
-        {
-          "name": "label",
-          "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
-          "values": []
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://pureui.xyz/components/breadcrumb"
-        }
-      ]
-    },
     {
       "name": "p-breadcrumb-item",
       "description": "Breadcrumb Items are used inside [breadcrumbs](/components/breadcrumb) to represent different links.\n---\n\n\n### **Slots:**\n - _default_ - The breadcrumb item's label.\n- **prefix** - An optional prefix, usually an icon or icon button.\n- **suffix** - An optional suffix, usually an icon or icon button.\n- **separator** - The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on `<p-breadcrumb>` instead.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **label** - The breadcrumb item's label.\n- **prefix** - The container that wraps the prefix.\n- **suffix** - The container that wraps the suffix.\n- **separator** - The container that wraps the separator.",
@@ -405,6 +388,23 @@
         }
       ]
     },
+    {
+      "name": "p-breadcrumb",
+      "description": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n---\n\n\n### **Slots:**\n - _default_ - One or more breadcrumb items to display.\n- **separator** - The separator to use between breadcrumb items. Works best with `<p-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
+      "attributes": [
+        {
+          "name": "label",
+          "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://pureui.xyz/components/breadcrumb"
+        }
+      ]
+    },
     {
       "name": "p-button-group",
       "description": "Button groups can be used to group related buttons into sections.\n---\n\n\n### **Slots:**\n - _default_ - One or more `<p-button>` elements to display in the button group.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
@@ -1785,17 +1785,6 @@
         }
       ]
     },
-    {
-      "name": "p-menu-label",
-      "description": "Menu labels are used to describe a group of menu items.\n---\n\n\n### **Slots:**\n - _default_ - The menu label's content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
-      "attributes": [],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://pureui.xyz/components/menu-label"
-        }
-      ]
-    },
     {
       "name": "p-mutation-observer",
       "description": "The Mutation Observer component offers a thin, declarative interface to the [`MutationObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver).\n---\n\n\n### **Events:**\n - **p-mutation** - Emitted when a mutation occurs.\n\n### **Slots:**\n - _default_ - The content to watch for mutations.",
@@ -1838,6 +1827,17 @@
         }
       ]
     },
+    {
+      "name": "p-menu-label",
+      "description": "Menu labels are used to describe a group of menu items.\n---\n\n\n### **Slots:**\n - _default_ - The menu label's content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
+      "attributes": [],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://pureui.xyz/components/menu-label"
+        }
+      ]
+    },
     {
       "name": "p-option",
       "description": "Options define the selectable items within various form controls such as [select](/components/select).\n---\n\n\n### **Methods:**\n - **getTextLabel()** - Returns a plain text label based on the option's content.\n\n### **Slots:**\n - _default_ - The option's label.\n- **prefix** - Used to prepend an icon or similar element to the menu item.\n- **suffix** - Used to append an icon or similar element to the menu item.\n\n### **CSS Parts:**\n - **checked-icon** - The checked icon, an `<p-icon>` element.\n- **base** - The component's base wrapper.\n- **label** - The option's label.\n- **prefix** - The container that wraps the prefix.\n- **suffix** - The container that wraps the suffix.",