@visitscotland/component-library 1.2.1 → 1.2.2

package/dist/components/components/progress-bar/ProgressBar.vue.d.ts

@@ -0,0 +1,96 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Total number of steps the bar represents
+     */
+    max: {
+        type: NumberConstructor;
+        required: true;
+    };
+    /**
+     * The current step the bar represents
+     */
+    currentStep: {
+        type: NumberConstructor;
+        required: true;
+    };
+    /**
+     * If set to true, instead of a single incremental progress bar, the component will
+     * display as a series of discrete blocks
+     */
+    isStepped: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    /**
+     * If set to true, the progress bar is marked as complete and highlighted in green
+     */
+    isFull: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    /**
+     * Localised string to indicate the current stage of the progress bar. Will be interpolated
+     * with the current step (on xxx) and total count (on yyy) to allow for different sentence
+     * orders.
+     *
+     * e.g. "Step xxx of yyy"
+     */
+    progressLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, {
+    compId: any;
+}, {
+    computedClasses(): string;
+    /**
+     * Interpolates the progress label into a localised string.
+     */
+    interpolProgressLabel(): any;
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Total number of steps the bar represents
+     */
+    max: {
+        type: NumberConstructor;
+        required: true;
+    };
+    /**
+     * The current step the bar represents
+     */
+    currentStep: {
+        type: NumberConstructor;
+        required: true;
+    };
+    /**
+     * If set to true, instead of a single incremental progress bar, the component will
+     * display as a series of discrete blocks
+     */
+    isStepped: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    /**
+     * If set to true, the progress bar is marked as complete and highlighted in green
+     */
+    isFull: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    /**
+     * Localised string to indicate the current stage of the progress bar. Will be interpolated
+     * with the current step (on xxx) and total count (on yyy) to allow for different sentence
+     * orders.
+     *
+     * e.g. "Step xxx of yyy"
+     */
+    progressLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    isStepped: boolean;
+    isFull: boolean;
+    progressLabel: string;
+}, {}>;
+export default _default;

package/dist/components/components/progress-bar/index.d.ts

@@ -0,0 +1,5 @@
+declare namespace _default {
+    export { VsProgressBar };
+}
+export default _default;
+import VsProgressBar from './ProgressBar.vue';

package/dist/components/components/quote/Quote.vue.d.ts

@@ -0,0 +1,21 @@
+declare const _default: import("vue").DefineComponent<{
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, any, any, {
+    hasAuthorName(): boolean;
+    hasAuthorTitle(): boolean;
+    hasAuthorImage(): boolean;
+    variantClass(): string;
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    variant: string;
+}, {}>;
+export default _default;

package/dist/components/components/quote/index.d.ts

@@ -0,0 +1,23 @@
+declare const _default: {
+    VsQuote: import("vue").DefineComponent<{
+        variant: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: unknown) => any;
+        };
+    }, any, any, {
+        hasAuthorName(): boolean;
+        hasAuthorTitle(): boolean;
+        hasAuthorImage(): boolean;
+        variantClass(): string;
+    }, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+        variant: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: unknown) => any;
+        };
+    }>>, {
+        variant: string;
+    }, {}>;
+};
+export default _default;

package/dist/components/components/radio-button/RadioButton.vue.d.ts

@@ -0,0 +1,233 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Default value of the field
+     */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Name of the field (for name and id attributes)
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prop to trigger manual validation. Used by a parent
+     * component to trigger validation eg. when the submit
+     * button is clicked.
+     */
+    triggerValidate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specific validation messages for different
+     * types of validation
+     */
+    validationMessages: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Fallback translated validation - this is a set of
+     * validation messages to be used when no specific
+     * validation message is needed, eg. "This field is required"
+     */
+    genericValidation: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Whether the parent form has just been submitted, if so all errors
+     * need to be wiped from then re-added to the DOM to inform screen
+     * readers that they should be re-declared
+     */
+    reAlertErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * An array of options that the user can select. Each should be an object with a `value`
+     * string (that is submitted as part of the answer to the carbon calculation), a `text`
+     * string which denotes what the answer represents, and an `icon` string which dictates
+     * which icon is rendered on the radio button.
+     */
+    options: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * An optional string which provides the user further information about how to answer
+     * the question. Appears below the radio button input.
+     */
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+}, {
+    v$: import("vue").Ref<import("@vuelidate/core").Validation<import("@vuelidate/core").ValidationArgs<unknown>, unknown>>;
+}, {
+    inputVal: string;
+    clearErrorsOnFocus: boolean;
+    checkedValue: string;
+}, {
+    /**
+     * element type class plus error classes
+     */
+    elementClass(): string;
+    showClearButton(): boolean;
+    errorClass(): "" | "vs-input--error";
+}, {
+    /**
+     * Clear any text entered in the input
+     */
+    clearInput(): void;
+    /**
+     * Focus on the input
+     */
+    focusOnInput(): void;
+    /**
+     * Validate errors on blur, and re-render them to the screen for screen
+     * reader notice
+     */
+    validateErrors(): void;
+    /**
+     * Reset field errors on focus to allow screen reader to notice them if still
+     * present on blur
+     */
+    resetErrors(): void;
+    valueChanged(newData: any): void;
+}, {
+    data(): {
+        inputVal: any;
+        isInvalid: any;
+    };
+    computed: {
+        isRequired(): boolean;
+        rules(): {
+            inputVal: {};
+        } | {
+            inputVal?: undefined;
+        };
+        errorsList(): any[];
+    };
+    watch: {
+        errorsList(newValue: any): void;
+    };
+    methods: {
+        manualValidate(): void;
+        emitStatus(): void;
+    };
+} | {
+    computed: {
+        ariaDescription(): string;
+    };
+}, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Default value of the field
+     */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Name of the field (for name and id attributes)
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prop to trigger manual validation. Used by a parent
+     * component to trigger validation eg. when the submit
+     * button is clicked.
+     */
+    triggerValidate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specific validation messages for different
+     * types of validation
+     */
+    validationMessages: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Fallback translated validation - this is a set of
+     * validation messages to be used when no specific
+     * validation message is needed, eg. "This field is required"
+     */
+    genericValidation: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Whether the parent form has just been submitted, if so all errors
+     * need to be wiped from then re-added to the DOM to inform screen
+     * readers that they should be re-declared
+     */
+    reAlertErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * An array of options that the user can select. Each should be an object with a `value`
+     * string (that is submitted as part of the answer to the carbon calculation), a `text`
+     * string which denotes what the answer represents, and an `icon` string which dictates
+     * which icon is rendered on the radio button.
+     */
+    options: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * An optional string which provides the user further information about how to answer
+     * the question. Appears below the radio button input.
+     */
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    value: string;
+    hintText: string;
+    invalid: boolean;
+    validationRules: Record<string, any>;
+    triggerValidate: boolean;
+    validationMessages: Record<string, any>;
+    genericValidation: Record<string, any>;
+    reAlertErrors: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/recaptcha/Recaptcha.vue.d.ts

@@ -0,0 +1,111 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Recaptcha site key string
+     */
+    siteKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether or not the form is invalid - this should
+     * also only be true when an attempt at submission has
+     * been made
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Language to show text in
+     */
+    language: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Validation message if the recaptcha isn't completed
+     */
+    errorMsg: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for invisible recaptcha textarea - tells
+     * screenreader users it's not needed
+     */
+    textareaLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the parent form has just been submitted, if so all errors
+     * need to be wiped from then re-added to the DOM to inform screen
+     * readers that they should be re-declared
+     */
+    reAlertErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, {
+    response: any;
+    recaptchaSiteKey: string;
+}, {}, {
+    verified(response: any): void;
+    render(): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Recaptcha site key string
+     */
+    siteKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether or not the form is invalid - this should
+     * also only be true when an attempt at submission has
+     * been made
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Language to show text in
+     */
+    language: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Validation message if the recaptcha isn't completed
+     */
+    errorMsg: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for invisible recaptcha textarea - tells
+     * screenreader users it's not needed
+     */
+    textareaLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the parent form has just been submitted, if so all errors
+     * need to be wiped from then re-added to the DOM to inform screen
+     * readers that they should be re-declared
+     */
+    reAlertErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    language: string;
+    invalid: boolean;
+    reAlertErrors: boolean;
+    siteKey: string;
+    errorMsg: string;
+    textareaLabel: string;
+}, {}>;
+export default _default;

package/dist/components/components/recaptcha/index.d.ts

@@ -0,0 +1,5 @@
+declare namespace _default {
+    export { VsRecaptcha };
+}
+export default _default;
+import VsRecaptcha from './Recaptcha.vue';

package/dist/components/components/rich-text-wrapper/RichTextWrapper.vue.d.ts

@@ -0,0 +1,24 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The font size used by the wrapper
+     * `normal|lead`
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The font size used by the wrapper
+     * `normal|lead`
+     */
+    variant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    variant: string;
+}, {}>;
+export default _default;

package/dist/components/components/rich-text-wrapper/index.d.ts

@@ -0,0 +1,5 @@
+declare namespace _default {
+    export { VsRichTextWrapper };
+}
+export default _default;
+import VsRichTextWrapper from './RichTextWrapper.vue';