@visitscotland/component-library 2.0.6 → 3.0.0

package/dist/components/components/select/Select.vue.d.ts

@@ -0,0 +1,213 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Options for select element
+     */
+    options: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Name of the field (for name and id attributes)
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Default value of the field
+     */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to trigger manual validation
+     */
+    triggerValidate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Validation messages
+     */
+    validationMessages: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * URL for list of countries file - this will be used
+     * if the 'country' prop is set to true
+     */
+    countryListUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the options should be a countries list
+     */
+    countries: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    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;
+    };
+}, {
+    v$: import('vue').Ref<import('@vuelidate/core').Validation<import('@vuelidate/core').ValidationArgs<unknown>, unknown>>;
+}, {
+    inputVal: string;
+    touched: boolean;
+    countryList: any[];
+}, {
+    errorClass(): "" | "vs-select__element--error";
+    fieldOptions(): any[];
+}, {
+    autocompleteValue(fieldName: any): string;
+}, {
+    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<{
+    /**
+     * Options for select element
+     */
+    options: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Name of the field (for name and id attributes)
+     */
+    fieldName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Default value of the field
+     */
+    value: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Rules for Vuelidate plugin
+     */
+    validationRules: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * Prop to trigger manual validation
+     */
+    triggerValidate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prop to define invalid from parent
+     */
+    invalid: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Validation messages
+     */
+    validationMessages: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /**
+     * URL for list of countries file - this will be used
+     * if the 'country' prop is set to true
+     */
+    countryListUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    hintText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Whether the options should be a countries list
+     */
+    countries: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    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;
+    };
+}>>, {
+    value: string;
+    hintText: string;
+    invalid: boolean;
+    validationRules: Record<string, any>;
+    triggerValidate: boolean;
+    validationMessages: Record<string, any>;
+    genericValidation: Record<string, any>;
+    reAlertErrors: boolean;
+    countryListUrl: string;
+    countries: boolean;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,2 @@
+import { default as VsSelect } from './Select.vue';
+export default VsSelect;

package/dist/components/components/site-search/SiteSearch.vue.d.ts

@@ -0,0 +1,27 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Used to know if the search form is currently showing
+     */
+    isShowing: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, {
+    showSearchForm: boolean;
+}, {}, {
+    /**
+     * Toggles search form and emits event with the data
+    */
+    toggleAction(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Used to know if the search form is currently showing
+     */
+    isShowing: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    isShowing: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/site-search/components/SiteSearchForm.vue.d.ts

@@ -0,0 +1,100 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Used to know if the search form is currently showing
+     */
+    isShowing: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Text that renders in form label (visually-hidden) and input placeholder
+     */
+    labelText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text that renders inside the submit button
+     */
+    submitButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text that renders inside the clear button (visually-hidden)
+     */
+    clearButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text that renders inside the close button (visually-hidden)
+     */
+    closeButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, {
+    searchTerm: string;
+    showSearchForm: boolean;
+}, {}, {
+    /**
+     * Puts focus on input when form is opened
+     */
+    focusOnInput(): void;
+    /**
+     * Update searchTerm value with returned data
+     */
+    updateVal(data: any): void;
+    /**
+     * Only submit if the field has a vale
+     */
+    onSubmit(e: any): void;
+    /**
+     * Closes the search form popover
+     */
+    closeSearchForm(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Used to know if the search form is currently showing
+     */
+    isShowing: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Text that renders in form label (visually-hidden) and input placeholder
+     */
+    labelText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text that renders inside the submit button
+     */
+    submitButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text that renders inside the clear button (visually-hidden)
+     */
+    clearButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text that renders inside the close button (visually-hidden)
+     */
+    closeButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    clearButtonText: string;
+    isShowing: boolean;
+    labelText: string;
+    submitButtonText: string;
+    closeButtonText: string;
+}, {}>;
+export default _default;

package/dist/components/components/site-search/index.d.ts

@@ -0,0 +1,7 @@
+import { default as VsSiteSearchForm } from './components/SiteSearchForm.vue';
+import { default as VsSiteSearch } from './SiteSearch.vue';
+declare namespace _default {
+    export { VsSiteSearchForm };
+    export { VsSiteSearch };
+}
+export default _default;

package/dist/components/components/ski-scotland/ski-scotland-card/SkiScotlandCard.vue.d.ts

@@ -0,0 +1,336 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+    * The url that the centre's summary information should be retrieved from for display
+    */
+    centreInfoUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Locale string determined by the language selected on the site. Used to localise
+     * the month in getLastUpdated
+     */
+    locale: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Determines how long the request should wait for a response from the api before
+     * giving up and displaying an error. Should be provided in milliseconds.
+     */
+    timeoutDuration: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Localisable label, translation of "last updated" for status tables
+     */
+    lastUpdatedLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "lifts" for status tables
+     */
+    liftsLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "runs" for status tables
+     */
+    runsLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "run/lift status" for the full
+     * report
+     */
+    runsLiftsStatusLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "status" for status tables
+     */
+    statusLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "closed" for the summary table
+     */
+    summaryClosedLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "open" for the summary table
+     */
+    summaryOpenLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "opening" for the summary table
+     */
+    summaryOpeningLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "limited patrol" for the summary table
+     */
+    summaryLimitedPatrolLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "on hold" for the summary table
+     */
+    summaryOnHoldLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The image to use in the card
+    */
+    imgSrc: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+    * The image alt text to use in the card
+    */
+    imgAlt: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Localisable label, translation of "view piste map" for the
+    * card links
+    */
+    pisteMapLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Localisable label, translation of "more details" for the
+    * card links
+    */
+    moreDetailsLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * An href pointing to the piste map for the ski centre
+    */
+    pisteMapLink: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * An href pointing to the ski status page for the ski centre
+    */
+    moreDetailsLink: {
+        type: StringConstructor;
+        required: true;
+        default: string;
+    };
+}, any, {
+    statusSummary: {
+        runs: {
+            open: number;
+            opening: number;
+            closed: number;
+            onHold: number;
+            limitedPatrol: number;
+        };
+        lifts: {
+            open: number;
+            opening: number;
+            closed: number;
+            onHold: number;
+            limitedPatrol: number;
+        };
+    };
+    runs: any[];
+    lifts: any[];
+    lastUpdate: string;
+    jsDisabled: boolean;
+    isLoading: boolean;
+    displayError: boolean;
+}, {}, {
+    /**
+     * Invoked when mounted, retrieves ski status info from the appropriate slope API
+     */
+    retrieveCentreInfo(): void;
+    cleanData(data: any): {
+        contact: any;
+        report: any;
+    };
+    processLastUpdate(lastUpdate: any): void;
+    processLifts(lifts: any): void;
+    processRuns(runs: any): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+    * The url that the centre's summary information should be retrieved from for display
+    */
+    centreInfoUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Locale string determined by the language selected on the site. Used to localise
+     * the month in getLastUpdated
+     */
+    locale: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Determines how long the request should wait for a response from the api before
+     * giving up and displaying an error. Should be provided in milliseconds.
+     */
+    timeoutDuration: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Localisable label, translation of "last updated" for status tables
+     */
+    lastUpdatedLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "lifts" for status tables
+     */
+    liftsLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "runs" for status tables
+     */
+    runsLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "run/lift status" for the full
+     * report
+     */
+    runsLiftsStatusLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "status" for status tables
+     */
+    statusLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "closed" for the summary table
+     */
+    summaryClosedLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "open" for the summary table
+     */
+    summaryOpenLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "opening" for the summary table
+     */
+    summaryOpeningLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "limited patrol" for the summary table
+     */
+    summaryLimitedPatrolLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Localisable label, translation of "on hold" for the summary table
+     */
+    summaryOnHoldLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * The image to use in the card
+    */
+    imgSrc: {
+        required: true;
+        type: StringConstructor;
+    };
+    /**
+    * The image alt text to use in the card
+    */
+    imgAlt: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Localisable label, translation of "view piste map" for the
+    * card links
+    */
+    pisteMapLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * Localisable label, translation of "more details" for the
+    * card links
+    */
+    moreDetailsLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * An href pointing to the piste map for the ski centre
+    */
+    pisteMapLink: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+    * An href pointing to the ski status page for the ski centre
+    */
+    moreDetailsLink: {
+        type: StringConstructor;
+        required: true;
+        default: string;
+    };
+}>>, {
+    imgAlt: string;
+    centreInfoUrl: string;
+    locale: string;
+    timeoutDuration: number;
+    lastUpdatedLabel: string;
+    liftsLabel: string;
+    runsLabel: string;
+    runsLiftsStatusLabel: string;
+    statusLabel: string;
+    summaryClosedLabel: string;
+    summaryOpenLabel: string;
+    summaryOpeningLabel: string;
+    summaryLimitedPatrolLabel: string;
+    summaryOnHoldLabel: string;
+    pisteMapLabel: string;
+    moreDetailsLabel: string;
+    pisteMapLink: string;
+    moreDetailsLink: string;
+}, {}>;
+export default _default;

package/dist/components/components/ski-scotland/ski-scotland-card/index.d.ts

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