@octans/ui 1.6.0 → 1.6.1

package/dist/components/CalendarHeatmap/types.d.ts

@@ -65,6 +65,13 @@ export interface CalendarHeatmapProps {
      * Renders a help icon next to the label which links to an external page.
      */
     helpLink?: string | false;
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon?: string;
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip?: string;
     /**
      * The data to plot, one entry per day.
      *

package/dist/components/Checkbox/Checkbox.vue.d.ts

@@ -19,6 +19,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
         type: PropType<string | false | null>;
         required: false;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     name: {
         type: StringConstructor;
     };
@@ -98,6 +109,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
         type: PropType<string | false | null>;
         required: false;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     name: {
         type: StringConstructor;
     };

package/dist/components/Choice/Choice.vue.d.ts

@@ -14,6 +14,19 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: PropType<string | false | null>;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text shown on hovering the `helpLink` icon.
+     */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     error: {
         type: PropType<string | false | null>;
     };
@@ -61,6 +74,19 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: PropType<string | false | null>;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text shown on hovering the `helpLink` icon.
+     */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     error: {
         type: PropType<string | false | null>;
     };
@@ -98,5 +124,6 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     type: string;
     tooltipPosition: string;
     value: any;
+    helpLinkIcon: string;
     readonly: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/ChoiceList/ChoiceList.vue.d.ts

@@ -18,6 +18,18 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: StringConstructor;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol. Per-choice links take theirs from
+     * the choice itself.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     /**
      * The choices to render. See `ChoiceListOptionType`, which is exported.
      *
@@ -27,6 +39,8 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
      *   value: any
      *   helpText?: string
      *   helpLink?: string
+     *   helpLinkIcon?: string
+     *   helpLinkTooltip?: string
      *   disabled?: boolean
      *   readonly?: boolean
      *   // shown only while this choice is selected
@@ -112,6 +126,18 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: StringConstructor;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol. Per-choice links take theirs from
+     * the choice itself.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     /**
      * The choices to render. See `ChoiceListOptionType`, which is exported.
      *
@@ -121,6 +147,8 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
      *   value: any
      *   helpText?: string
      *   helpLink?: string
+     *   helpLinkIcon?: string
+     *   helpLinkTooltip?: string
      *   disabled?: boolean
      *   readonly?: boolean
      *   // shown only while this choice is selected

package/dist/components/ChoiceList/types.d.ts

@@ -18,6 +18,13 @@ export interface ChoiceListOptionType {
      * Renders a help icon next to the label which links to an external page.
      */
     helpLink?: string;
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon?: string;
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip?: string;
     disabled?: boolean;
     readonly?: boolean;
     /**

package/dist/components/ColorSelector/types.d.ts

@@ -56,6 +56,13 @@ export interface ColorSelectorProps extends Omit<ColorPickerProps, 'modelValue'>
      * Renders a help icon next to the label which links to an external page.
      */
     helpLink?: string | false | null;
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon?: string;
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip?: string;
     /**
      * Where the picker opens relative to the trigger.
      */

package/dist/components/DatePicker/types.d.ts

@@ -15,6 +15,13 @@ export interface DatePickerProps {
      * Renders a help icon next to the label which links to an external page.
      */
     helpLink?: string | false;
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon?: string;
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip?: string;
     placeholder?: string;
     disabled?: boolean;
     readonly?: boolean;

package/dist/components/FileInput/FileInput.vue.d.ts

@@ -37,6 +37,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: PropType<string | false | null>;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     /**
      * Marks the field as required, drawing an asterisk after the label.
      *
@@ -153,6 +164,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: PropType<string | false | null>;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     /**
      * Marks the field as required, drawing an asterisk after the label.
      *
@@ -467,6 +489,14 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             type: PropType<string | false | null>;
             required: false;
         };
+        helpLinkIcon: {
+            type: StringConstructor;
+            default: string;
+        };
+        helpLinkTooltip: {
+            type: StringConstructor;
+            required: false;
+        };
         required: {
             type: BooleanConstructor;
             required: false;
@@ -494,12 +524,21 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             type: PropType<string | false | null>;
             required: false;
         };
+        helpLinkIcon: {
+            type: StringConstructor;
+            default: string;
+        };
+        helpLinkTooltip: {
+            type: StringConstructor;
+            required: false;
+        };
         required: {
             type: BooleanConstructor;
             required: false;
         };
     }>> & Readonly<{}>, {
         required: boolean;
+        helpLinkIcon: string;
     }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
     Spinner: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
         color: {

package/dist/components/Filters/FilterItem.vue.d.ts

@@ -310,6 +310,12 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
         helpLink: {
             type: import('vue').PropType<string | false | null>;
         };
+        helpLinkIcon: {
+            type: StringConstructor;
+        };
+        helpLinkTooltip: {
+            type: StringConstructor;
+        };
         required: {
             type: BooleanConstructor;
             default: boolean;
@@ -485,6 +491,12 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
         helpLink: {
             type: import('vue').PropType<string | false | null>;
         };
+        helpLinkIcon: {
+            type: StringConstructor;
+        };
+        helpLinkTooltip: {
+            type: StringConstructor;
+        };
         required: {
             type: BooleanConstructor;
             default: boolean;
@@ -704,6 +716,14 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                 type: import('vue').PropType<string | false | null>;
                 required: false;
             };
+            helpLinkIcon: {
+                type: StringConstructor;
+                default: string;
+            };
+            helpLinkTooltip: {
+                type: StringConstructor;
+                required: false;
+            };
             required: {
                 type: BooleanConstructor;
                 required: false;
@@ -731,12 +751,21 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                 type: import('vue').PropType<string | false | null>;
                 required: false;
             };
+            helpLinkIcon: {
+                type: StringConstructor;
+                default: string;
+            };
+            helpLinkTooltip: {
+                type: StringConstructor;
+                required: false;
+            };
             required: {
                 type: BooleanConstructor;
                 required: false;
             };
         }>> & Readonly<{}>, {
             required: boolean;
+            helpLinkIcon: string;
         }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
         Tag: {
             new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../Tag/Tag.vue').TagProps> & Readonly<{

package/dist/components/Filters/Filters.vue.d.ts

@@ -929,6 +929,12 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             helpLink: {
                 type: PropType<string | false | null>;
             };
+            helpLinkIcon: {
+                type: StringConstructor;
+            };
+            helpLinkTooltip: {
+                type: StringConstructor;
+            };
             required: {
                 type: BooleanConstructor;
                 default: boolean;
@@ -1104,6 +1110,12 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             helpLink: {
                 type: PropType<string | false | null>;
             };
+            helpLinkIcon: {
+                type: StringConstructor;
+            };
+            helpLinkTooltip: {
+                type: StringConstructor;
+            };
             required: {
                 type: BooleanConstructor;
                 default: boolean;
@@ -1323,6 +1335,14 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                     type: PropType<string | false | null>;
                     required: false;
                 };
+                helpLinkIcon: {
+                    type: StringConstructor;
+                    default: string;
+                };
+                helpLinkTooltip: {
+                    type: StringConstructor;
+                    required: false;
+                };
                 required: {
                     type: BooleanConstructor;
                     required: false;
@@ -1350,12 +1370,21 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
                     type: PropType<string | false | null>;
                     required: false;
                 };
+                helpLinkIcon: {
+                    type: StringConstructor;
+                    default: string;
+                };
+                helpLinkTooltip: {
+                    type: StringConstructor;
+                    required: false;
+                };
                 required: {
                     type: BooleanConstructor;
                     required: false;
                 };
             }>> & Readonly<{}>, {
                 required: boolean;
+                helpLinkIcon: string;
             }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
             Tag: {
                 new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../Tag/Tag.vue').TagProps> & Readonly<{

package/dist/components/Labelled/Labelled.vue.d.ts

@@ -45,6 +45,28 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
         type: PropType<string | false | null>;
         required: false;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     *
+     * Defaults to an information symbol. Change it where the link means
+     * something narrower than "help": `mdi:language-markdown` beside a field
+     * that accepts markdown says what the link is about before it is clicked.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text shown on hovering the `helpLink` icon.
+     *
+     * Worth setting whenever the icon is not self-evident. The link opens in a
+     * new tab, so this is the reader's only chance to find out where it goes
+     * before they lose their place in the form.
+     */
+    helpLinkTooltip: {
+        type: StringConstructor;
+        required: false;
+    };
     /**
      * Marks the field as required, drawing an asterisk after the label.
      *
@@ -106,6 +128,28 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
         type: PropType<string | false | null>;
         required: false;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     *
+     * Defaults to an information symbol. Change it where the link means
+     * something narrower than "help": `mdi:language-markdown` beside a field
+     * that accepts markdown says what the link is about before it is clicked.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text shown on hovering the `helpLink` icon.
+     *
+     * Worth setting whenever the icon is not self-evident. The link opens in a
+     * new tab, so this is the reader's only chance to find out where it goes
+     * before they lose their place in the form.
+     */
+    helpLinkTooltip: {
+        type: StringConstructor;
+        required: false;
+    };
     /**
      * Marks the field as required, drawing an asterisk after the label.
      *
@@ -123,4 +167,5 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     };
 }>> & Readonly<{}>, {
     required: boolean;
+    helpLinkIcon: string;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/NavField/NavField.vue.d.ts

@@ -26,6 +26,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: PropType<string | false | null>;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     placeholder: {
         type: StringConstructor;
     };
@@ -74,6 +85,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: PropType<string | false | null>;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     placeholder: {
         type: StringConstructor;
     };
@@ -164,6 +186,14 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             type: PropType<string | false | null>;
             required: false;
         };
+        helpLinkIcon: {
+            type: StringConstructor;
+            default: string;
+        };
+        helpLinkTooltip: {
+            type: StringConstructor;
+            required: false;
+        };
         required: {
             type: BooleanConstructor;
             required: false;
@@ -191,12 +221,21 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             type: PropType<string | false | null>;
             required: false;
         };
+        helpLinkIcon: {
+            type: StringConstructor;
+            default: string;
+        };
+        helpLinkTooltip: {
+            type: StringConstructor;
+            required: false;
+        };
         required: {
             type: BooleanConstructor;
             required: false;
         };
     }>> & Readonly<{}>, {
         required: boolean;
+        helpLinkIcon: string;
     }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
     Spinner: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
         color: {

package/dist/components/OtpInput/types.d.ts

@@ -19,6 +19,13 @@ export interface OtpInputProps {
      * Renders a help icon next to the label which links to an external page.
      */
     helpLink?: string | false;
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon?: string;
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip?: string;
     /**
      * The current value — the characters across all cells joined into a string.
      */

package/dist/components/RadioButton/RadioButton.vue.d.ts

@@ -26,6 +26,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: PropType<string | false | null>;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     /**
      * Radio buttons with the same name will form a group.
      */
@@ -93,6 +104,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: PropType<string | false | null>;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     /**
      * Radio buttons with the same name will form a group.
      */

package/dist/components/RangeSlider/RangeSlider.vue.d.ts

@@ -45,6 +45,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: PropType<string | false | null>;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     /**
      * Disables the control and prevents all interaction.
      */
@@ -149,6 +160,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
     helpLink: {
         type: PropType<string | false | null>;
     };
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon: {
+        type: StringConstructor;
+    };
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip: {
+        type: StringConstructor;
+    };
     /**
      * Disables the control and prevents all interaction.
      */
@@ -225,6 +247,14 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             type: PropType<string | false | null>;
             required: false;
         };
+        helpLinkIcon: {
+            type: StringConstructor;
+            default: string;
+        };
+        helpLinkTooltip: {
+            type: StringConstructor;
+            required: false;
+        };
         required: {
             type: BooleanConstructor;
             required: false;
@@ -252,12 +282,21 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
             type: PropType<string | false | null>;
             required: false;
         };
+        helpLinkIcon: {
+            type: StringConstructor;
+            default: string;
+        };
+        helpLinkTooltip: {
+            type: StringConstructor;
+            required: false;
+        };
         required: {
             type: BooleanConstructor;
             required: false;
         };
     }>> & Readonly<{}>, {
         required: boolean;
+        helpLinkIcon: string;
     }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
     TextField: {
         new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../TextField').TextFieldProps> & Readonly<{

package/dist/components/Rating/types.d.ts

@@ -19,6 +19,13 @@ export interface RatingProps {
      * Renders a help icon next to the label which links to an external page.
      */
     helpLink?: string | false;
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon?: string;
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip?: string;
     /**
      * The current rating value. `null` or `0` means unrated.
      */

package/dist/components/SegmentedControl/types.d.ts

@@ -116,4 +116,11 @@ export interface SegmentedControlProps {
      * Renders a help icon next to the label which links to an external page.
      */
     helpLink?: string;
+    /**
+     * The icon drawn for `helpLink` — any name the `Icon` component takes.
+     * Defaults to an information symbol.
+     */
+    helpLinkIcon?: string;
+    /** Text shown on hovering the `helpLink` icon. */
+    helpLinkTooltip?: string;
 }