@roadtrip/components 2.25.0 → 2.25.1

package/dist/types/components.d.ts

@@ -9,7 +9,7 @@ import { AutocompleteTypes, Color, FeedbackColors, TextFieldTypes } from "./inte
 export namespace Components {
     interface RoadAccordion {
         /**
-          * Set open to true to show the accordion element and to false to hide it.
+          * Set to `true` to open the accordion and to `false` to close it.
          */
         "isOpen": boolean;
     }
@@ -60,7 +60,7 @@ export namespace Components {
         /**
           * Set to `true` for a full-width button.
          */
-        "expand"?: boolean;
+        "expand": boolean;
         /**
           * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
          */
@@ -76,7 +76,7 @@ export namespace Components {
         /**
           * The button size.
          */
-        "size"?: 'sm' | 'md';
+        "size"?: 'sm' | 'md' | 'lg';
         /**
           * Specifies where to display the linked URL. Only applies when an `href` is provided. Special keywords: `"_blank"`, `"_self"`, `"_parent"`, `"_top"`.
          */
@@ -209,7 +209,7 @@ export namespace Components {
          */
         "checkboxId": string;
         /**
-          * If `true`, the checkbox is selected.
+          * If `true`, the checkbox is checked.
          */
         "checked": boolean;
         /**
@@ -247,15 +247,15 @@ export namespace Components {
          */
         "color"?: 'default' | 'secondary';
         /**
-          * Display close icon
+          * Display a close icon
          */
         "hasCloseIcon": boolean;
         /**
-          * Display an outline style button.
+          * Display an outline style chip.
          */
         "outline": boolean;
         /**
-          * Display an outline style button.
+          * The chip size.
          */
         "size": 'md' | 'lg';
     }
@@ -263,15 +263,15 @@ export namespace Components {
     }
     interface RoadCollapse {
         /**
-          * if "`true`" the button will be centered
+          * if `true` the button will be centered
          */
         "centered": boolean;
         /**
-          * Set open to true to show the accordion element and to false to hide it.
+          * Set to `true` to display the collapsed part and to `false` to hide it.
          */
         "isOpen": boolean;
         /**
-          * Text displayed in the button when the content is collapsed
+          * Text displayed in the button when the content is not collapsed
          */
         "showLess": string;
         /**
@@ -281,7 +281,7 @@ export namespace Components {
     }
     interface RoadCounter {
         /**
-          * The id of input
+          * The id of counter
          */
         "inputId": string;
         /**
@@ -301,7 +301,7 @@ export namespace Components {
          */
         "step"?: string;
         /**
-          * The value of the input.
+          * The value of the counter.
          */
         "value": number;
     }
@@ -391,7 +391,7 @@ export namespace Components {
     }
     interface RoadDropdown {
         /**
-          * Set open to true to show the dropdown menu.
+          * Set to `true` to open the dropdown menu and to `false` to close it.
          */
         "isOpen": boolean;
     }
@@ -890,7 +890,7 @@ export namespace Components {
     }
     interface RoadSwitch {
         /**
-          * If `true`, the toggle is selected.
+          * If `true`, the switch is checked.
          */
         "checked": boolean;
         /**
@@ -898,7 +898,7 @@ export namespace Components {
          */
         "color"?: 'secondary' | FeedbackColors;
         /**
-          * If `true`, the user cannot interact with the toggle.
+          * If `true`, the user cannot interact with the switch.
          */
         "disabled": boolean;
         /**
@@ -926,7 +926,7 @@ export namespace Components {
          */
         "on": string;
         /**
-          * The id of input
+          * The id of switch
          */
         "switchId": string;
         /**
@@ -1019,7 +1019,7 @@ export namespace Components {
          */
         "autocapitalize": string;
         /**
-          * This Boolean attribute lets you specify that a form control should have input focus when the page loads.
+          * This Boolean attribute lets you specify that a form control should have focus when the page loads.
          */
         "autofocus": boolean;
         /**
@@ -1027,7 +1027,7 @@ export namespace Components {
          */
         "cols"?: number;
         /**
-          * If `true`, the user cannot interact with the input.
+          * If `true`, the user cannot interact with the textarea.
          */
         "disabled": boolean;
         /**
@@ -1059,7 +1059,7 @@ export namespace Components {
          */
         "name": string;
         /**
-          * Instructional text that shows before the input has a value.
+          * Instructional text that shows before the textarea has a value.
          */
         "placeholder"?: string;
         /**
@@ -1079,11 +1079,11 @@ export namespace Components {
          */
         "spellcheck": boolean;
         /**
-          * The id of input
+          * The id of textarea
          */
         "textareaId": string;
         /**
-          * The value of the input.
+          * The value of the textarea.
          */
         "value"?: string | null;
         /**
@@ -1097,11 +1097,11 @@ export namespace Components {
          */
         "close": () => Promise<void>;
         /**
-          * Set the color of toast. e.g. info, success, warning, danger
+          * Set the color of the toast. e.g. info, success, warning, danger
          */
         "color": FeedbackColors;
         /**
-          * Set open propertie to true to show the toast
+          * Set `open` propertie to `true` to open the toast
          */
         "isOpen": boolean;
         /**
@@ -1131,7 +1131,7 @@ export namespace Components {
     }
     interface RoadTooltip {
         /**
-          * Shows the tooltip.
+          * Close the tooltip.
          */
         "close": () => Promise<void>;
         /**
@@ -1143,7 +1143,7 @@ export namespace Components {
          */
         "isOpen": boolean;
         /**
-          * Shows the tooltip.
+          * Open the tooltip.
          */
         "open": () => Promise<void>;
         /**
@@ -1534,7 +1534,7 @@ declare global {
 declare namespace LocalJSX {
     interface RoadAccordion {
         /**
-          * Set open to true to show the accordion element and to false to hide it.
+          * Set to `true` to open the accordion and to `false` to close it.
          */
         "isOpen"?: boolean;
     }
@@ -1616,7 +1616,7 @@ declare namespace LocalJSX {
         /**
           * The button size.
          */
-        "size"?: 'sm' | 'md';
+        "size"?: 'sm' | 'md' | 'lg';
         /**
           * Specifies where to display the linked URL. Only applies when an `href` is provided. Special keywords: `"_blank"`, `"_self"`, `"_parent"`, `"_top"`.
          */
@@ -1745,7 +1745,7 @@ declare namespace LocalJSX {
          */
         "checkboxId"?: string;
         /**
-          * If `true`, the checkbox is selected.
+          * If `true`, the checkbox is checked.
          */
         "checked"?: boolean;
         /**
@@ -1769,7 +1769,7 @@ declare namespace LocalJSX {
          */
         "name"?: string;
         /**
-          * Emitted when the toggle loses focus.
+          * Emitted when the checkbox loses focus.
          */
         "onRoadBlur"?: (event: CustomEvent<void>) => void;
         /**
@@ -1780,7 +1780,7 @@ declare namespace LocalJSX {
     value: string | undefined | null
   }>) => void;
         /**
-          * Emitted when the toggle has focus.
+          * Emitted when the checkbox has focus.
          */
         "onRoadFocus"?: (event: CustomEvent<void>) => void;
         /**
@@ -1798,15 +1798,15 @@ declare namespace LocalJSX {
          */
         "color"?: 'default' | 'secondary';
         /**
-          * Display close icon
+          * Display a close icon
          */
         "hasCloseIcon"?: boolean;
         /**
-          * Display an outline style button.
+          * Display an outline style chip.
          */
         "outline"?: boolean;
         /**
-          * Display an outline style button.
+          * The chip size.
          */
         "size"?: 'md' | 'lg';
     }
@@ -1814,15 +1814,15 @@ declare namespace LocalJSX {
     }
     interface RoadCollapse {
         /**
-          * if "`true`" the button will be centered
+          * if `true` the button will be centered
          */
         "centered"?: boolean;
         /**
-          * Set open to true to show the accordion element and to false to hide it.
+          * Set to `true` to display the collapsed part and to `false` to hide it.
          */
         "isOpen"?: boolean;
         /**
-          * Text displayed in the button when the content is collapsed
+          * Text displayed in the button when the content is not collapsed
          */
         "showLess"?: string;
         /**
@@ -1832,7 +1832,7 @@ declare namespace LocalJSX {
     }
     interface RoadCounter {
         /**
-          * The id of input
+          * The id of counter
          */
         "inputId"?: string;
         /**
@@ -1860,7 +1860,7 @@ declare namespace LocalJSX {
          */
         "step"?: string;
         /**
-          * The value of the input.
+          * The value of the counter.
          */
         "value"?: number;
     }
@@ -1946,7 +1946,7 @@ declare namespace LocalJSX {
     }
     interface RoadDropdown {
         /**
-          * Set open to true to show the dropdown menu.
+          * Set to `true` to open the dropdown menu and to `false` to close it.
          */
         "isOpen"?: boolean;
     }
@@ -2530,7 +2530,7 @@ declare namespace LocalJSX {
     }
     interface RoadSwitch {
         /**
-          * If `true`, the toggle is selected.
+          * If `true`, the switch is checked.
          */
         "checked"?: boolean;
         /**
@@ -2538,7 +2538,7 @@ declare namespace LocalJSX {
          */
         "color"?: 'secondary' | FeedbackColors;
         /**
-          * If `true`, the user cannot interact with the toggle.
+          * If `true`, the user cannot interact with the switch.
          */
         "disabled"?: boolean;
         /**
@@ -2566,7 +2566,7 @@ declare namespace LocalJSX {
          */
         "on"?: string;
         /**
-          * Emitted when the toggle loses focus.
+          * Emitted when the switch loses focus.
          */
         "onRoadBlur"?: (event: CustomEvent<void>) => void;
         /**
@@ -2577,11 +2577,11 @@ declare namespace LocalJSX {
     value: string | undefined | null
   }>) => void;
         /**
-          * Emitted when the toggle has focus.
+          * Emitted when the switch has focus.
          */
         "onRoadFocus"?: (event: CustomEvent<void>) => void;
         /**
-          * The id of input
+          * The id of switch
          */
         "switchId"?: string;
         /**
@@ -2663,7 +2663,7 @@ declare namespace LocalJSX {
          */
         "autocapitalize"?: string;
         /**
-          * This Boolean attribute lets you specify that a form control should have input focus when the page loads.
+          * This Boolean attribute lets you specify that a form control should have focus when the page loads.
          */
         "autofocus"?: boolean;
         /**
@@ -2671,7 +2671,7 @@ declare namespace LocalJSX {
          */
         "cols"?: number;
         /**
-          * If `true`, the user cannot interact with the input.
+          * If `true`, the user cannot interact with the textarea.
          */
         "disabled"?: boolean;
         /**
@@ -2703,7 +2703,7 @@ declare namespace LocalJSX {
          */
         "name"?: string;
         /**
-          * Emitted when the input loses focus.
+          * Emitted when the textarea loses focus.
          */
         "onRoadBlur"?: (event: CustomEvent<void>) => void;
         /**
@@ -2713,7 +2713,7 @@ declare namespace LocalJSX {
     value: string | undefined | null
   }>) => void;
         /**
-          * Emitted when the input has focus.
+          * Emitted when the textarea has focus.
          */
         "onRoadFocus"?: (event: CustomEvent<void>) => void;
         /**
@@ -2721,7 +2721,7 @@ declare namespace LocalJSX {
          */
         "onRoadInput"?: (event: CustomEvent<KeyboardEvent>) => void;
         /**
-          * Instructional text that shows before the input has a value.
+          * Instructional text that shows before the textarea has a value.
          */
         "placeholder"?: string;
         /**
@@ -2741,11 +2741,11 @@ declare namespace LocalJSX {
          */
         "spellcheck"?: boolean;
         /**
-          * The id of input
+          * The id of textarea
          */
         "textareaId"?: string;
         /**
-          * The value of the input.
+          * The value of the textarea.
          */
         "value"?: string | null;
         /**
@@ -2755,11 +2755,11 @@ declare namespace LocalJSX {
     }
     interface RoadToast {
         /**
-          * Set the color of toast. e.g. info, success, warning, danger
+          * Set the color of the toast. e.g. info, success, warning, danger
          */
         "color"?: FeedbackColors;
         /**
-          * Set open propertie to true to show the toast
+          * Set `open` propertie to `true` to open the toast
          */
         "isOpen"?: boolean;
         /**

package/dist/types/stencil-public-runtime.d.ts

@@ -666,7 +666,7 @@ export declare namespace JSXBase {
         use: JSXBase.SVGAttributes;
         view: JSXBase.SVGAttributes;
     }
-    interface SlotAttributes {
+    interface SlotAttributes extends JSXAttributes {
         name?: string;
         slot?: string;
         onSlotchange?: (event: Event) => void;
@@ -1427,9 +1427,7 @@ export declare namespace JSXBase {
         z?: number | string;
         zoomAndPan?: string;
     }
-    interface DOMAttributes<T = Element> {
-        key?: string | number;
-        ref?: (elm?: T) => void;
+    interface DOMAttributes<T> extends JSXAttributes<T> {
         slot?: string;
         part?: string;
         exportparts?: string;
@@ -1550,6 +1548,10 @@ export declare namespace JSXBase {
         onTransitionEndCapture?: (event: TransitionEvent) => void;
     }
 }
+export interface JSXAttributes<T = Element> {
+    key?: string | number;
+    ref?: (elm?: T) => void;
+}
 export interface CustomElementsDefineOptions {
     exclude?: string[];
     resourcesUrl?: string;