@pine-ds/core 3.8.2 → 3.10.0

package/dist/types/components.d.ts

@@ -27,6 +27,7 @@ export namespace Components {
     interface MockPdsModal {
         /**
           * Whether the modal can be dismissed by clicking the backdrop
+          * @default true
          */
         "backdropDismiss": boolean;
         /**
@@ -39,6 +40,7 @@ export namespace Components {
         "hideModal": () => Promise<void>;
         /**
           * Whether the modal is open
+          * @default false
          */
         "open": boolean;
         /**
@@ -52,6 +54,7 @@ export namespace Components {
         "showModal": () => Promise<void>;
         /**
           * The size of the modal
+          * @default 'md'
          */
         "size": 'sm' | 'md' | 'lg' | 'fullscreen';
     }
@@ -83,6 +86,7 @@ export namespace Components {
         "heading": string;
         /**
           * If true, the alert is displayed in a smaller size and description text is truncated. Heading is not displayed.
+          * @default false
          */
         "small": boolean;
         /**
@@ -218,6 +222,7 @@ export namespace Components {
         "backgroundColor"?: string;
         /**
           * If `true`, the box will have a border.
+          * @default false
          */
         "border"?: boolean;
         /**
@@ -717,6 +722,7 @@ export namespace Components {
         "icon"?: string;
         /**
           * When true, displays only the icon and visually hides the text (keeping it accessible).
+          * @default false
          */
         "iconOnly"?: boolean;
         /**
@@ -728,6 +734,11 @@ export namespace Components {
           * Provides the button with a submittable name.
          */
         "name"?: string;
+        /**
+          * Sets the size of the button.
+          * @defaultValue default
+         */
+        "size"?: 'default' | 'small' | 'micro';
         /**
           * Specifies where to open the linked document when href is provided. Only applies when href is set.
          */
@@ -745,11 +756,12 @@ export namespace Components {
           * Sets the style variant of the button.
           * @defaultValue primary
          */
-        "variant": 'primary' | 'secondary' | 'accent' | 'disclosure' | 'destructive' | 'unstyled' | 'filter';
+        "variant": 'primary' | 'secondary' | 'tertiary' | 'accent' | 'disclosure' | 'destructive' | 'unstyled' | 'filter';
     }
     interface PdsCheckbox {
         /**
           * It determines whether or not the checkbox is checked.
+          * @default false
          */
         "checked"?: boolean;
         /**
@@ -863,6 +875,7 @@ export namespace Components {
         "customTriggerContent": boolean;
         /**
           * If true, the combobox is disabled.
+          * @default false
          */
         "disabled": boolean;
         /**
@@ -881,6 +894,7 @@ export namespace Components {
         "getSelectedValue": () => Promise<string | null>;
         /**
           * Visually hides the label text for instances where only the combobox should be displayed. Label remains accessible to assistive technology such as screen readers.
+          * @default false
          */
         "hideLabel": boolean;
         /**
@@ -925,6 +939,7 @@ export namespace Components {
         "triggerWidth": string;
         /**
           * The value of the combobox input.
+          * @default ''
          */
         "value": string;
     }
@@ -975,6 +990,7 @@ export namespace Components {
         "componentId": string;
         /**
           * The placement of the dropdown panel relative to the trigger.
+          * @default 'bottom-start'
          */
         "placement": PlacementType;
     }
@@ -1121,6 +1137,10 @@ export namespace Components {
           * Visually hides the label text for instances where only the input should be displayed. Label remains accessible to assistive technology such as screen readers. Note: When true, the action slot is also hidden to maintain a minimal UI.
          */
         "hideLabel": boolean;
+        /**
+          * Applies highlight styling to the input field.
+         */
+        "highlight"?: boolean;
         /**
           * Determines whether or not the input field is invalid or throws an error.
          */
@@ -1180,6 +1200,7 @@ export namespace Components {
         "type": string;
         /**
           * The value of the input.
+          * @default ''
          */
         "value"?: string | number | null;
     }
@@ -1215,14 +1236,17 @@ export namespace Components {
     interface PdsLoader {
         /**
           * If false, the loader will be hidden.
+          * @default true
          */
         "isLoading": boolean;
         /**
           * Determines whether the loader should display a label.
+          * @default false
          */
         "showLabel"?: boolean;
         /**
           * Sets the size of the spinner loader. Value can be preset or custom.
+          * @default 'md'
          */
         "size"?: | 'xs' // 24px
   | 'sm' // 32px
@@ -1232,6 +1256,7 @@ export namespace Components {
   | string;
         /**
           * Determines the type of loader.
+          * @default 'spinner'
          */
         "variant": 'spinner' | 'typing';
     }
@@ -1306,16 +1331,13 @@ export namespace Components {
         "popoverTargetAction": 'show' | 'toggle' | 'hide';
         /**
           * Determines the type of popover. Auto popovers can be "light dismissed" by clicking outside of the popover. Manual popovers require the consumer to handle the visibility of the popover.
+          * @default 'auto'
          */
         "popoverType": 'auto' | 'manual';
         /**
           * Opens the popover programmatically
          */
         "show": () => Promise<void>;
-        /**
-          * Text that appears on the trigger element
-         */
-        "text": string;
         /**
           * Toggles the popover open/closed state programmatically
          */
@@ -1358,6 +1380,7 @@ export namespace Components {
         "componentId": string;
         /**
           * The name of the icon to display before the property text.
+          * @default 'star'
          */
         "icon": string;
     }
@@ -1424,6 +1447,7 @@ export namespace Components {
         "alignItems"?: `start` | `center` | `end` | `baseline` | `stretch`;
         /**
           * If `true`, the row will have a border.
+          * @default false
          */
         "border"?: boolean;
         /**
@@ -1453,6 +1477,7 @@ export namespace Components {
         "minHeight"?: string;
         /**
           * If `true`, the row items will not wrap to the next line if horizontal space is not available.
+          * @default false
          */
         "noWrap"?: boolean;
     }
@@ -1482,6 +1507,10 @@ export namespace Components {
           * Visually hides the label text for instances where only the select should be displayed. Label remains accessible to assistive technology such as screen readers. Note: When true, the action slot is also hidden to maintain a minimal UI.
          */
         "hideLabel": boolean;
+        /**
+          * Applies highlight styling to the select field.
+         */
+        "highlight"?: boolean;
         /**
           * Determines whether or not the select is invalid.
          */
@@ -1521,10 +1550,12 @@ export namespace Components {
         "componentId": string;
         /**
           * Deternines whether `sortable` items should be divided with border.
+          * @default false
          */
         "dividers": boolean;
         /**
           * Determines the grabbable area for the `pds-sortable-item`.
+          * @default 'row'
          */
         "handleType": 'handle' | 'row';
     }
@@ -1547,6 +1578,7 @@ export namespace Components {
     interface PdsSwitch {
         /**
           * Determines the input 'checked' state.
+          * @default false
          */
         "checked": boolean;
         /**
@@ -1555,6 +1587,7 @@ export namespace Components {
         "componentId": string;
         /**
           * Determines the input 'disabled' state, preventing user interaction.
+          * @default false
          */
         "disabled"?: boolean;
         /**
@@ -1571,6 +1604,7 @@ export namespace Components {
         "hideLabel": boolean;
         /**
           * Determines the input 'invalid' state, signifying an error is present.
+          * @default false
          */
         "invalid"?: boolean;
         /**
@@ -1583,6 +1617,7 @@ export namespace Components {
         "name": string;
         /**
           * Determines the 'required' state of the input.
+          * @default false
          */
         "required"?: boolean;
         /**
@@ -1597,6 +1632,9 @@ export namespace Components {
          */
         "name": string;
         "parentComponentId": string;
+        /**
+          * @default false
+         */
         "selected": boolean;
         "variant": string;
     }
@@ -1671,6 +1709,9 @@ export namespace Components {
          */
         "name": string;
         "parentComponentId": string;
+        /**
+          * @default false
+         */
         "selected": boolean;
         "variant": string;
     }
@@ -1739,6 +1780,7 @@ export namespace Components {
   | 'h6';
         /**
           * Determines what semantic text tag to render.
+          * @default "p"
          */
         "tag": | 'h1'
   | 'h2'
@@ -1795,6 +1837,10 @@ export namespace Components {
           * Visually hides the label text for instances where only the textarea should be displayed. Label remains accessible to assistive technology such as screen readers. Note: When true, the action slot is also hidden to maintain a minimal UI.
          */
         "hideLabel": boolean;
+        /**
+          * Applies highlight styling to the textarea field.
+         */
+        "highlight"?: boolean;
         /**
           * Determines whether or not the textarea is invalid or throws an error.
           * @defaultValue false
@@ -1810,6 +1856,7 @@ export namespace Components {
         "maxLength"?: number;
         /**
           * Specifies the name. Submitted with the form name/value pair. This value will mirror the componentId.
+          * @default this.componentId
          */
         "name": string;
         /**
@@ -1836,6 +1883,7 @@ export namespace Components {
         "setFocus": () => Promise<void>;
         /**
           * The value of the textarea.
+          * @default ''
          */
         "value"?: string | null;
     }
@@ -2612,6 +2660,7 @@ declare namespace LocalJSX {
     interface MockPdsModal {
         /**
           * Whether the modal can be dismissed by clicking the backdrop
+          * @default true
          */
         "backdropDismiss"?: boolean;
         /**
@@ -2632,6 +2681,7 @@ declare namespace LocalJSX {
         "onPdsModalOpen"?: (event: MockPdsModalCustomEvent<any>) => void;
         /**
           * Whether the modal is open
+          * @default false
          */
         "open"?: boolean;
         /**
@@ -2641,6 +2691,7 @@ declare namespace LocalJSX {
         "scrollable"?: boolean;
         /**
           * The size of the modal
+          * @default 'md'
          */
         "size"?: 'sm' | 'md' | 'lg' | 'fullscreen';
     }
@@ -2676,6 +2727,7 @@ declare namespace LocalJSX {
         "onPdsAlertDismissClick"?: (event: PdsAlertCustomEvent<void>) => void;
         /**
           * If true, the alert is displayed in a smaller size and description text is truncated. Heading is not displayed.
+          * @default false
          */
         "small"?: boolean;
         /**
@@ -2811,6 +2863,7 @@ declare namespace LocalJSX {
         "backgroundColor"?: string;
         /**
           * If `true`, the box will have a border.
+          * @default false
          */
         "border"?: boolean;
         /**
@@ -3310,6 +3363,7 @@ declare namespace LocalJSX {
         "icon"?: string;
         /**
           * When true, displays only the icon and visually hides the text (keeping it accessible).
+          * @default false
          */
         "iconOnly"?: boolean;
         /**
@@ -3322,6 +3376,11 @@ declare namespace LocalJSX {
          */
         "name"?: string;
         "onPdsClick"?: (event: PdsButtonCustomEvent<any>) => void;
+        /**
+          * Sets the size of the button.
+          * @defaultValue default
+         */
+        "size"?: 'default' | 'small' | 'micro';
         /**
           * Specifies where to open the linked document when href is provided. Only applies when href is set.
          */
@@ -3339,11 +3398,12 @@ declare namespace LocalJSX {
           * Sets the style variant of the button.
           * @defaultValue primary
          */
-        "variant"?: 'primary' | 'secondary' | 'accent' | 'disclosure' | 'destructive' | 'unstyled' | 'filter';
+        "variant"?: 'primary' | 'secondary' | 'tertiary' | 'accent' | 'disclosure' | 'destructive' | 'unstyled' | 'filter';
     }
     interface PdsCheckbox {
         /**
           * It determines whether or not the checkbox is checked.
+          * @default false
          */
         "checked"?: boolean;
         /**
@@ -3466,6 +3526,7 @@ declare namespace LocalJSX {
         "customTriggerContent"?: boolean;
         /**
           * If true, the combobox is disabled.
+          * @default false
          */
         "disabled"?: boolean;
         /**
@@ -3480,6 +3541,7 @@ declare namespace LocalJSX {
         "dropdownWidth"?: string;
         /**
           * Visually hides the label text for instances where only the combobox should be displayed. Label remains accessible to assistive technology such as screen readers.
+          * @default false
          */
         "hideLabel"?: boolean;
         /**
@@ -3524,6 +3586,7 @@ declare namespace LocalJSX {
         "triggerWidth"?: string;
         /**
           * The value of the combobox input.
+          * @default ''
          */
         "value"?: string;
     }
@@ -3578,6 +3641,7 @@ declare namespace LocalJSX {
         "componentId"?: string;
         /**
           * The placement of the dropdown panel relative to the trigger.
+          * @default 'bottom-start'
          */
         "placement"?: PlacementType;
     }
@@ -3728,6 +3792,10 @@ declare namespace LocalJSX {
           * Visually hides the label text for instances where only the input should be displayed. Label remains accessible to assistive technology such as screen readers. Note: When true, the action slot is also hidden to maintain a minimal UI.
          */
         "hideLabel"?: boolean;
+        /**
+          * Applies highlight styling to the input field.
+         */
+        "highlight"?: boolean;
         /**
           * Determines whether or not the input field is invalid or throws an error.
          */
@@ -3799,6 +3867,7 @@ declare namespace LocalJSX {
         "type"?: string;
         /**
           * The value of the input.
+          * @default ''
          */
         "value"?: string | number | null;
     }
@@ -3834,14 +3903,17 @@ declare namespace LocalJSX {
     interface PdsLoader {
         /**
           * If false, the loader will be hidden.
+          * @default true
          */
         "isLoading"?: boolean;
         /**
           * Determines whether the loader should display a label.
+          * @default false
          */
         "showLabel"?: boolean;
         /**
           * Sets the size of the spinner loader. Value can be preset or custom.
+          * @default 'md'
          */
         "size"?: | 'xs' // 24px
   | 'sm' // 32px
@@ -3851,6 +3923,7 @@ declare namespace LocalJSX {
   | string;
         /**
           * Determines the type of loader.
+          * @default 'spinner'
          */
         "variant"?: 'spinner' | 'typing';
     }
@@ -3929,12 +4002,9 @@ declare namespace LocalJSX {
         "popoverTargetAction"?: 'show' | 'toggle' | 'hide';
         /**
           * Determines the type of popover. Auto popovers can be "light dismissed" by clicking outside of the popover. Manual popovers require the consumer to handle the visibility of the popover.
+          * @default 'auto'
          */
         "popoverType"?: 'auto' | 'manual';
-        /**
-          * Text that appears on the trigger element
-         */
-        "text"?: string;
     }
     interface PdsProgress {
         /**
@@ -3973,6 +4043,7 @@ declare namespace LocalJSX {
         "componentId"?: string;
         /**
           * The name of the icon to display before the property text.
+          * @default 'star'
          */
         "icon"?: string;
     }
@@ -4043,6 +4114,7 @@ declare namespace LocalJSX {
         "alignItems"?: `start` | `center` | `end` | `baseline` | `stretch`;
         /**
           * If `true`, the row will have a border.
+          * @default false
          */
         "border"?: boolean;
         /**
@@ -4072,6 +4144,7 @@ declare namespace LocalJSX {
         "minHeight"?: string;
         /**
           * If `true`, the row items will not wrap to the next line if horizontal space is not available.
+          * @default false
          */
         "noWrap"?: boolean;
     }
@@ -4101,6 +4174,10 @@ declare namespace LocalJSX {
           * Visually hides the label text for instances where only the select should be displayed. Label remains accessible to assistive technology such as screen readers. Note: When true, the action slot is also hidden to maintain a minimal UI.
          */
         "hideLabel"?: boolean;
+        /**
+          * Applies highlight styling to the select field.
+         */
+        "highlight"?: boolean;
         /**
           * Determines whether or not the select is invalid.
          */
@@ -4144,10 +4221,12 @@ declare namespace LocalJSX {
         "componentId": string;
         /**
           * Deternines whether `sortable` items should be divided with border.
+          * @default false
          */
         "dividers"?: boolean;
         /**
           * Determines the grabbable area for the `pds-sortable-item`.
+          * @default 'row'
          */
         "handleType"?: 'handle' | 'row';
         /**
@@ -4174,6 +4253,7 @@ declare namespace LocalJSX {
     interface PdsSwitch {
         /**
           * Determines the input 'checked' state.
+          * @default false
          */
         "checked"?: boolean;
         /**
@@ -4182,6 +4262,7 @@ declare namespace LocalJSX {
         "componentId": string;
         /**
           * Determines the input 'disabled' state, preventing user interaction.
+          * @default false
          */
         "disabled"?: boolean;
         /**
@@ -4198,6 +4279,7 @@ declare namespace LocalJSX {
         "hideLabel"?: boolean;
         /**
           * Determines the input 'invalid' state, signifying an error is present.
+          * @default false
          */
         "invalid"?: boolean;
         /**
@@ -4214,6 +4296,7 @@ declare namespace LocalJSX {
         "onPdsSwitchChange"?: (event: PdsSwitchCustomEvent<InputEvent>) => void;
         /**
           * Determines the 'required' state of the input.
+          * @default false
          */
         "required"?: boolean;
         /**
@@ -4382,6 +4465,7 @@ declare namespace LocalJSX {
   | 'h6';
         /**
           * Determines what semantic text tag to render.
+          * @default "p"
          */
         "tag"?: | 'h1'
   | 'h2'
@@ -4438,6 +4522,10 @@ declare namespace LocalJSX {
           * Visually hides the label text for instances where only the textarea should be displayed. Label remains accessible to assistive technology such as screen readers. Note: When true, the action slot is also hidden to maintain a minimal UI.
          */
         "hideLabel"?: boolean;
+        /**
+          * Applies highlight styling to the textarea field.
+         */
+        "highlight"?: boolean;
         /**
           * Determines whether or not the textarea is invalid or throws an error.
           * @defaultValue false
@@ -4453,6 +4541,7 @@ declare namespace LocalJSX {
         "maxLength"?: number;
         /**
           * Specifies the name. Submitted with the form name/value pair. This value will mirror the componentId.
+          * @default this.componentId
          */
         "name"?: string;
         /**
@@ -4491,6 +4580,7 @@ declare namespace LocalJSX {
         "rows"?: number;
         /**
           * The value of the textarea.
+          * @default ''
          */
         "value"?: string | null;
     }