tide-design-system 2.0.28 → 2.0.30

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

@@ -584,6 +584,18 @@ export declare type BadgePremium = (typeof BADGE_PREMIUM)[keyof typeof BADGE_PRE
 
 export declare type BadgeTrustedYears = (typeof BADGE_TRUSTED)[keyof typeof BADGE_TRUSTED];
 
+export declare type BooleanField = CheckboxField;
+
+export declare type BooleanInput = CheckboxInput;
+
+export declare interface BooleanValue {
+    value?: boolean;
+}
+
+declare interface BooleanValue_2 {
+    value?: boolean;
+}
+
 export declare type BreadCrumb = {
     dataTrack?: string;
     label: string;
@@ -599,6 +611,15 @@ export declare const BREAKPOINT: {
 
 export declare type Breakpoint = (typeof BREAKPOINT)[keyof typeof BREAKPOINT];
 
+export declare interface CheckboxField extends GenericInput, BooleanValue {
+    indeterminate?: boolean;
+}
+
+export declare type CheckboxInput = GenericInput_2 & BooleanValue_2 & {
+    checked?: boolean;
+    indeterminate?: boolean;
+};
+
 declare const CSS_2: {
     readonly withBreakpoint: (utilities: string[], breakpoint: Breakpoint) => string[];
     readonly ALIGN: {
@@ -1019,9 +1040,48 @@ export declare const ELEMENT_TEXT_AS_ICON: {
 
 export declare type ElementTextAsIcon = (typeof ELEMENT_TEXT_AS_ICON)[keyof typeof ELEMENT_TEXT_AS_ICON];
 
-declare type FormValueTransformer = (value: string) => string;
+declare const FACET_COMPONENT_ID_RANGE: {
+    readonly GROSS_WEIGHT: "grossWeight";
+    readonly LENGTH: "vehicleLength";
+    readonly MILEAGE: "mileage";
+    readonly PRICE: "price";
+    readonly SLEEPING_CAPACITY: "sleepingCapacity";
+    readonly SLIDEOUTS: "slideouts";
+    readonly YEAR: "vehicleYear";
+};
+
+export declare type FacetComponentIdRange = (typeof FACET_COMPONENT_ID_RANGE)[keyof typeof FACET_COMPONENT_ID_RANGE];
+
+export declare type Field = SelectField | TextField | TextareaField | CheckboxField;
+
+export declare const FORMAT: {
+    readonly NUMBER: (input: string | number) => string;
+    readonly PHONE: (input: string | number) => string;
+    readonly PRICE: (input: string | number) => string;
+};
+
+export declare const FORMAT_REGEX: {
+    alpha: RegExp;
+    alphaNumberOrEmpty: RegExp;
+    alphaSpace: RegExp;
+    email: RegExp;
+    numberFormatted: RegExp;
+    phone: RegExp;
+    price: RegExp;
+};
+
+export declare type Formatted = {
+    [key: string]: string | string[] | number;
+};
+
+export declare type FormValueTransformer = (value: string) => string;
+
+export declare interface GenericField extends GenericInput {
+    transformValue?: FormValueTransformer;
+    validators?: Validator[];
+}
 
-declare interface GenericInput {
+export declare interface GenericInput {
     disabled?: boolean;
     error: ValidationError;
     label?: string;
@@ -1029,6 +1089,16 @@ declare interface GenericInput {
     required?: boolean;
 }
 
+declare interface GenericInput_2 {
+    error?: ValidationError;
+    transformValue?: FormValueTransformer;
+    name: string;
+    validators?: Validator[];
+    required?: boolean;
+    label?: string;
+    disabled?: boolean;
+}
+
 export declare const ICON: {
     readonly ACCOUNT_BALANCE: "account-balance";
     readonly ADD: "add";
@@ -1117,18 +1187,44 @@ export declare const ICON: {
 
 export declare type Icon = (typeof ICON)[keyof typeof ICON];
 
+declare type ImageSlide = {
+    imageUrl: string;
+    type: ImageSlideType;
+};
+
+export declare type ImageSlideType = (typeof MEDIA_SLIDE_TYPES.IMAGE)[keyof typeof MEDIA_SLIDE_TYPES.IMAGE];
+
+export declare type Input = SelectInput | TextInput | TextareaInput | CheckboxInput;
+
 export declare type Link = {
     label: string;
     url: string;
     isNewTab?: boolean;
 };
 
-declare const ORIENTATION: {
+export declare type ListingMedia = ImageSlide | VideoSlide | VrSlide;
+
+/**
+ * These slides are used in both the inline detail page photo slider
+ * and the fullscreen media gallery.
+ */
+export declare const MEDIA_SLIDE_TYPES: {
+    readonly IMAGE: {
+        readonly FLOORPLAN: "floorplan";
+        readonly IMAGE: "image";
+    };
+    readonly VIDEO: "video";
+    readonly VR: "vr";
+};
+
+export declare type MediaSlideType = (typeof MEDIA_SLIDE_TYPES.IMAGE)[keyof typeof MEDIA_SLIDE_TYPES.IMAGE] | typeof MEDIA_SLIDE_TYPES.VIDEO | typeof MEDIA_SLIDE_TYPES.VR;
+
+export declare const ORIENTATION: {
     readonly HORIZONTAL: "horizontal";
     readonly VERTICAL: "vertical";
 };
 
-declare type Orientation = (typeof ORIENTATION)[keyof typeof ORIENTATION];
+export declare type Orientation = (typeof ORIENTATION)[keyof typeof ORIENTATION];
 
 export declare const PRIORITY: {
     readonly PRIMARY: "primary";
@@ -1316,6 +1412,17 @@ declare type Props_9 = {
     offsetX?: number;
 };
 
+export declare type RangeData = {
+    min: number | null;
+    max: number | null;
+};
+
+export declare type Raw = {
+    [key: string]: {
+        raw: number | string | string[];
+    };
+};
+
 export declare const REALM: {
     readonly AERO: "aero";
     readonly ATV: "atv";
@@ -1330,15 +1437,40 @@ export declare const REALM: {
 
 export declare type Realm = (typeof REALM)[keyof typeof REALM];
 
-declare interface SelectField extends GenericInput, StringValue {
-    options: SelectOption[];
+export declare type RealmConfig = {
+    cdn: {
+        domain: string;
+        version: string;
+    };
+    id: Realm;
+    label: {
+        plural: string;
+        singular: string;
+        singularWithArticle: string;
+    };
+};
+
+export declare interface SelectField extends GenericInput, StringValue {
+    optgroups?: SelectOptionGroup[];
+    options?: SelectOption[];
 }
 
-declare type SelectOption = {
+export declare type SelectInput = GenericInput_2 & StringValue_2 & {
+    options?: SelectOption[] | readonly SelectOption[];
+    placeholder?: string;
+    optgroups?: SelectOptionGroup[];
+};
+
+export declare type SelectOption = {
     label: string | number;
     value: any;
 };
 
+export declare type SelectOptionGroup = {
+    label: string;
+    options?: SelectOption[];
+};
+
 export declare const SIZE: {
     readonly LARGE: "large";
     readonly SMALL: "small";
@@ -1346,7 +1478,15 @@ export declare const SIZE: {
 
 export declare type Size = (typeof SIZE)[keyof typeof SIZE];
 
-declare interface StringValue {
+export declare type StringField = SelectField | TextField | TextareaField;
+
+export declare type StringInput = SelectInput | TextInput | TextareaInput;
+
+export declare interface StringValue {
+    value?: string;
+}
+
+declare interface StringValue_2 {
     value?: string;
 }
 
@@ -1363,7 +1503,7 @@ export declare const TARGET: {
 
 export declare type Target = (typeof TARGET)[keyof typeof TARGET];
 
-declare const TEXT_INPUT_TYPE: {
+export declare const TEXT_INPUT_TYPE: {
     readonly DATE: "date";
     readonly DATETIME_LOCAL: "datetime-local";
     readonly EMAIL: "email";
@@ -1378,7 +1518,38 @@ declare const TEXT_INPUT_TYPE: {
     readonly WEEK: "week";
 };
 
-declare type TextInputType = (typeof TEXT_INPUT_TYPE)[keyof typeof TEXT_INPUT_TYPE];
+export declare interface TextareaField extends GenericField, StringValue {
+    maxlength?: number;
+    minlength?: number;
+    placeholder?: string;
+    value?: string;
+}
+
+export declare type TextareaInput = GenericInput_2 & StringValue_2 & {
+    maxlength?: number;
+    minlength?: number;
+    placeholder?: string;
+    value?: string;
+};
+
+export declare interface TextField extends GenericField, StringValue {
+    maxlength?: number;
+    minlength?: number;
+    placeholder?: string;
+    type?: TextInputType;
+    value?: string;
+}
+
+export declare type TextInput = GenericInput_2 & StringValue_2 & {
+    autocomplete?: boolean;
+    maxlength?: number;
+    minlength?: number;
+    type?: TextInputType;
+    placeholder?: string;
+    value?: string;
+};
+
+export declare type TextInputType = (typeof TEXT_INPUT_TYPE)[keyof typeof TEXT_INPUT_TYPE];
 
 export declare const TideAccordionItem: __VLS_WithTemplateSlots<DefineComponent<    {
 hasBottomDivider: {
@@ -1940,6 +2111,22 @@ export declare const VALIDATOR: {
     readonly PHONE: (value: string) => ValidationResult;
 };
 
-declare type Validator = (value: string) => ValidationResult;
+export declare type Validator = (value: string) => ValidationResult;
+
+declare type VideoSlide = {
+    imageUrl: string;
+    type: VideoSlideType;
+    videoUrl: string;
+};
+
+export declare type VideoSlideType = typeof MEDIA_SLIDE_TYPES.VIDEO;
+
+declare type VrSlide = {
+    imageUrl: string;
+    type: VrSlideType;
+    vrUrl: string;
+};
+
+export declare type VrSlideType = typeof MEDIA_SLIDE_TYPES.VR;
 
 export { }