tide-design-system 2.4.4 → 2.4.7

package/dist/tide-design-system.esm.d.ts

@@ -1,3 +1,4 @@
+import { Component } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
 import { DefineComponent } from 'vue';
@@ -40,6 +41,12 @@ declare type __VLS_WithTemplateSlots<T, S> = T & {
     };
 };
 
+declare type __VLS_WithTemplateSlots_10<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
 declare type __VLS_WithTemplateSlots_2<T, S> = T & {
     new (): {
         $slots: S;
@@ -118,6 +125,10 @@ export declare const BADGE_COLOR_DETAILS: Record<BadgeColor, {
 export declare const BADGE_TRUSTED: {
     readonly YEARS_10: "10";
     readonly YEARS_15: "15";
+    readonly YEARS_20: "20";
+    readonly YEARS_25: "25";
+    readonly YEARS_30: "30";
+    readonly YEARS_35: "35";
     readonly YEARS_5: "5";
 };
 
@@ -140,6 +151,13 @@ export declare const BREAKPOINT: {
 
 export declare type Breakpoint = (typeof BREAKPOINT)[keyof typeof BREAKPOINT];
 
+declare const BUTTON_TYPE: {
+    readonly BUTTON: "button";
+    readonly SUBMIT: "submit";
+};
+
+declare type ButtonType = (typeof BUTTON_TYPE)[keyof typeof BUTTON_TYPE];
+
 export declare type CardType = (typeof TYPE_CARD)[keyof typeof TYPE_CARD];
 
 declare const CSS_2: {
@@ -666,13 +684,13 @@ export declare const ELEMENT: {
 declare type Element_2 = (typeof ELEMENT)[keyof typeof ELEMENT];
 export { Element_2 as Element }
 
-export declare const ELEMENT_TEXT_AS_ICON: {
+export declare const ELEMENT_BROAD: {
     readonly BUTTON: "button";
     readonly DIV: "div";
     readonly LINK: "a";
 };
 
-export declare type ElementTextAsIcon = (typeof ELEMENT_TEXT_AS_ICON)[keyof typeof ELEMENT_TEXT_AS_ICON];
+export declare type ElementBroad = (typeof ELEMENT_BROAD)[keyof typeof ELEMENT_BROAD];
 
 declare const ERROR_DISPLAY: {
     readonly EAGER: "eager";
@@ -695,6 +713,7 @@ export declare const FORMAT_REGEX: {
     numberFormatted: RegExp;
     phone: RegExp;
     price: RegExp;
+    zip: RegExp;
 };
 
 export declare type Formatted = {
@@ -977,7 +996,6 @@ declare type Props_11 = {
     isHeadline1?: boolean;
     isHideawayButtons?: boolean;
     isScrollByPage?: boolean;
-    isTouchscreen?: boolean;
     maxDots?: number;
     subtitle?: string;
     title?: string;
@@ -1031,6 +1049,7 @@ declare type Props_19 = {
 
 declare type Props_2 = {
     heading?: string;
+    ctaLabel?: string;
     isDismissible?: boolean;
     isToast?: boolean;
     type?: Alert;
@@ -1181,6 +1200,7 @@ declare type Props_6 = {
     label: string;
     priority?: Priority;
     size?: SizeButton;
+    type?: ButtonType;
 };
 
 declare type Props_7 = {
@@ -1190,11 +1210,12 @@ declare type Props_7 = {
     icon: Icon;
     isNewTab?: boolean;
     priority?: Priority;
+    type?: ButtonType;
 };
 
 declare type Props_8 = {
     disabled?: boolean;
-    element?: ElementTextAsIcon;
+    element?: ElementBroad;
     href?: string;
     label: string | number;
 };
@@ -1204,6 +1225,8 @@ declare type Props_9 = {
     tabs: Tab[];
 };
 
+export declare const provideTideConfig: (config?: Partial<TideConfig>) => void;
+
 export declare const REALM: {
     readonly AERO: "aero";
     readonly ATV: "atv";
@@ -1335,11 +1358,14 @@ isOptional: boolean;
 
 export declare const TideAlert: __VLS_WithTemplateSlots_2<DefineComponent<Props_2, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
 close: () => any;
+ctaClick: () => any;
 }, string, PublicProps, Readonly<Props_2> & Readonly<{
 onClose?: (() => any) | undefined;
+onCtaClick?: (() => any) | undefined;
 }>, {
 type: Alert;
 heading: string;
+ctaLabel: string;
 isDismissible: boolean;
 isToast: boolean;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, {
@@ -1347,8 +1373,8 @@ isToast: boolean;
 }>;
 
 export declare const TideBadge: DefineComponent<Props_3, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_3> & Readonly<{}>, {
-color: BadgeColor;
 iconLeading: Icon;
+color: BadgeColor;
 isFloating: boolean;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
@@ -1363,6 +1389,7 @@ breadCrumbs: BreadCrumb[];
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 export declare const TideButton: DefineComponent<Props_6, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_6> & Readonly<{}>, {
+type: ButtonType;
 label: string;
 size: SizeButton;
 disabled: boolean;
@@ -1375,6 +1402,7 @@ iconTrailing: Icon;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 export declare const TideButtonIcon: DefineComponent<Props_7, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_7> & Readonly<{}>, {
+type: ButtonType;
 icon: Icon;
 disabled: boolean;
 element: Element_2;
@@ -1386,7 +1414,7 @@ priority: Priority;
 export declare const TideButtonPagination: DefineComponent<Props_8, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_8> & Readonly<{}>, {
 label: string | number;
 disabled: boolean;
-element: ElementTextAsIcon;
+element: ElementBroad;
 href: string;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
@@ -1417,7 +1445,6 @@ hasDots: boolean;
 isHeadline1: boolean;
 isHideawayButtons: boolean;
 isScrollByPage: boolean;
-isTouchscreen: boolean;
 maxDots: number;
 subtitle: string;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, {
@@ -1446,10 +1473,22 @@ heading: string;
     section4?(_: {}): any;
 }>;
 
+declare type TideConfig = {
+    linkComponent: Component | typeof ELEMENT.LINK;
+};
+
 export declare const TideDivider: DefineComponent<Props_16, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_16> & Readonly<{}>, {
 orientation: Orientation;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
+export declare const TideForm: __VLS_WithTemplateSlots_6<DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+submit: (e: SubmitEvent) => any;
+}, string, PublicProps, Readonly<{}> & Readonly<{
+onSubmit?: ((e: SubmitEvent) => any) | undefined;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>, {
+    default?(_: {}): any;
+}>;
+
 export declare const TideIcon: DefineComponent<Props_17, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_17> & Readonly<{}>, {
 size: Size;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
@@ -1464,7 +1503,7 @@ sources: Source[];
 src: string;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
-export declare const TideImageBackground: __VLS_WithTemplateSlots_6<DefineComponent<Props_19, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_19> & Readonly<{}>, {
+export declare const TideImageBackground: __VLS_WithTemplateSlots_7<DefineComponent<Props_19, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_19> & Readonly<{}>, {
 alt: string;
 isLazy: boolean;
 sources: Source[];
@@ -1765,7 +1804,41 @@ iconTrailing: Icon;
 subtle: boolean;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
-export declare const TideModal: __VLS_WithTemplateSlots_7<DefineComponent<Props_28, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+/**
+ * Renders a generic menu item intended to be used in navigation menus or dropdowns.
+ *
+ * @see the [Storybook interface](https://tide-design-system.netlify.app/?path=/docs/components-tidemenuitem--docs) for TideMenuItem
+ */
+export declare const TideMenuItem: DefineComponent<    {
+/** The element to render the root element as. */
+element?: Element_2 | undefined;
+/** The href attribute to apply when the element is a link. */
+href?: string | undefined;
+/** Whether to open link in a new tab. */
+isNewTab?: boolean | undefined;
+/** Icon to show after the label. */
+iconTrailing?: Icon | undefined;
+/** The label to be displayed. */
+label: string;
+}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{
+/** The element to render the root element as. */
+element?: Element_2 | undefined;
+/** The href attribute to apply when the element is a link. */
+href?: string | undefined;
+/** Whether to open link in a new tab. */
+isNewTab?: boolean | undefined;
+/** Icon to show after the label. */
+iconTrailing?: Icon | undefined;
+/** The label to be displayed. */
+label: string;
+}> & Readonly<{}>, {
+element: Element_2;
+href: string;
+isNewTab: boolean;
+iconTrailing: Icon;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+export declare const TideModal: __VLS_WithTemplateSlots_8<DefineComponent<Props_28, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
 close: () => any;
 back: () => any;
 }, string, PublicProps, Readonly<Props_28> & Readonly<{
@@ -1790,7 +1863,7 @@ pageCurrent: number;
 pageTotal: number;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
-export declare const TidePopover: __VLS_WithTemplateSlots_8<DefineComponent<Props_30, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_30> & Readonly<{}>, {
+export declare const TidePopover: __VLS_WithTemplateSlots_9<DefineComponent<Props_30, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props_30> & Readonly<{}>, {
 offset: number;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, {
     default?(_: {}): any;
@@ -1800,7 +1873,7 @@ export declare const TideSeoLinks: DefineComponent<Props_31, {}, {}, {}, {}, Com
 heading: string;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
-export declare const TideSheet: __VLS_WithTemplateSlots_9<DefineComponent<Props_32, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+export declare const TideSheet: __VLS_WithTemplateSlots_10<DefineComponent<Props_32, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
 close: () => any;
 back: () => any;
 }, string, PublicProps, Readonly<Props_32> & Readonly<{
@@ -1862,6 +1935,7 @@ export declare const VALIDATOR: {
     readonly EMAIL: (value: string) => ValidationResult;
     readonly NUMBER: (value: string) => ValidationResult;
     readonly PHONE: (value: string) => ValidationResult;
+    readonly ZIP: (value: string) => ValidationResult;
 };
 
 export declare type Validator = (value: string) => ValidationResult;