@visitscotland/component-library 1.2.1 → 1.2.2

package/dist/components/components/summary-box/components/SummaryBoxListItem.vue.d.ts

@@ -0,0 +1,67 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The highlighted, large text in the centre of the list item
+     */
+    text: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Smaller text at the bottom of the list item
+     */
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * An icon that appears in the centre of the list item, should
+     * be used instead of text rather than as well as
+     */
+    icon: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * A text label that appears next to an icon, if an icon is set
+     */
+    iconLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The highlighted, large text in the centre of the list item
+     */
+    text: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Smaller text at the bottom of the list item
+     */
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * An icon that appears in the centre of the list item, should
+     * be used instead of text rather than as well as
+     */
+    icon: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * A text label that appears next to an icon, if an icon is set
+     */
+    iconLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    label: string;
+    text: string;
+    icon: string;
+    iconLabel: string;
+}, {}>;
+export default _default;

package/dist/components/components/summary-box/index.d.ts

@@ -0,0 +1,4 @@
+import VsSummaryBoxList from './SummaryBoxList.vue';
+import VsSummaryBoxListItem from './components/SummaryBoxListItem.vue';
+import VsSummaryBoxDistanceListItem from './components/SummaryBoxDistanceListItem.vue';
+export { VsSummaryBoxList, VsSummaryBoxListItem, VsSummaryBoxDistanceListItem };

package/dist/components/components/svg/Svg.vue.d.ts

@@ -0,0 +1,75 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The path of the SVG to display, relative to /src/assets
+     */
+    path: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+ * The fill color of the SVG
+ */
+    fill: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+ * The height attribute of the SVG
+ */
+    height: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /**
+ * The width attribute of the SVG
+ */
+    width: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+}, any, {
+    svg: any;
+}, {
+    nativeAttrs(): {
+        [x: string]: string;
+    };
+    attributes(): {
+        [x: string]: string;
+    };
+    nativeStyleAttrMap(): import("lodash").Dictionary<any>;
+    children(): any;
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The path of the SVG to display, relative to /src/assets
+     */
+    path: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+ * The fill color of the SVG
+ */
+    fill: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+ * The height attribute of the SVG
+ */
+    height: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /**
+ * The width attribute of the SVG
+ */
+    width: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+}>>, {
+    fill: string;
+    width: string | number;
+    height: string | number;
+}, {}>;
+export default _default;

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

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

package/dist/components/components/svg-link/SvgLink.vue.d.ts

@@ -0,0 +1,126 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Accessiblity alt text for the SVG link
+     */
+    linkAltText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The URL for the SVG link
+     */
+    href: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The fill color of the SVG
+     */
+    svgFill: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The path of the SVG to display, relative to /src/assets
+     */
+    svgPath: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The height attribute of the SVG
+     */
+    svgHeight: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /**
+     * The width attribute of the SVG
+     */
+    svgWidth: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /**
+    * If the click should trigger a dataLayerPush
+    */
+    dataLayerValue: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Option to choose a pre-defined link variant
+     * `primary|on-dark`
+     */
+    linkVariant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Accessiblity alt text for the SVG link
+     */
+    linkAltText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The URL for the SVG link
+     */
+    href: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The fill color of the SVG
+     */
+    svgFill: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The path of the SVG to display, relative to /src/assets
+     */
+    svgPath: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The height attribute of the SVG
+     */
+    svgHeight: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /**
+     * The width attribute of the SVG
+     */
+    svgWidth: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /**
+    * If the click should trigger a dataLayerPush
+    */
+    dataLayerValue: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Option to choose a pre-defined link variant
+     * `primary|on-dark`
+     */
+    linkVariant: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    svgFill: string;
+    linkVariant: string;
+    dataLayerValue: string;
+    svgHeight: string | number;
+    svgWidth: string | number;
+}, {}>;
+export default _default;

package/dist/components/components/svg-link/index.d.ts

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

package/dist/components/components/table/Table.vue.d.ts

@@ -0,0 +1,41 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The table caption for screen readers
+     */
+    tableCaption: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The type of table to display
+     * `responsive|stacked`
+     */
+    tableType: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}, any, any, {
+    responsive(): boolean;
+    stacked(): boolean;
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The table caption for screen readers
+     */
+    tableCaption: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The type of table to display
+     * `responsive|stacked`
+     */
+    tableType: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    tableType: string;
+}, {}>;
+export default _default;

package/dist/components/components/table/components/TableBody.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

package/dist/components/components/table/components/TableDataCell.vue.d.ts

@@ -0,0 +1,20 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The heading to read when the table is in stacked mode
+     */
+    stackedHeading: {
+        type: StringConstructor;
+        default: any;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The heading to read when the table is in stacked mode
+     */
+    stackedHeading: {
+        type: StringConstructor;
+        default: any;
+    };
+}>>, {
+    stackedHeading: string;
+}, {}>;
+export default _default;

package/dist/components/components/table/components/TableFooter.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

package/dist/components/components/table/components/TableHead.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

package/dist/components/components/table/components/TableHeaderCell.vue.d.ts

@@ -0,0 +1,20 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The heading to read when the table is in stacked mode
+     */
+    stackedHeading: {
+        type: StringConstructor;
+        default: any;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The heading to read when the table is in stacked mode
+     */
+    stackedHeading: {
+        type: StringConstructor;
+        default: any;
+    };
+}>>, {
+    stackedHeading: string;
+}, {}>;
+export default _default;

package/dist/components/components/table/components/TableRow.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

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

@@ -0,0 +1,8 @@
+import VsTable from './Table.vue';
+import VsTableBody from './components/TableBody.vue';
+import VsTableDataCell from './components/TableDataCell.vue';
+import VsTableFooter from './components/TableFooter.vue';
+import VsTableHead from './components/TableHead.vue';
+import VsTableHeaderCell from './components/TableHeaderCell.vue';
+import VsTableRow from './components/TableRow.vue';
+export { VsTable, VsTableBody, VsTableDataCell, VsTableFooter, VsTableHead, VsTableHeaderCell, VsTableRow };

package/dist/components/components/tabs/Tabs.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

package/dist/components/components/tabs/components/TabItem.vue.d.ts

@@ -0,0 +1,18 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Title of the tab button
+     */
+    title: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Title of the tab button
+     */
+    title: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;

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

@@ -0,0 +1,9 @@
+declare namespace _default {
+    export { VsTabs };
+    export { VsTabItem };
+    export { BTab };
+}
+export default _default;
+import VsTabs from './Tabs.vue';
+import VsTabItem from './components/TabItem.vue';
+import { BTab } from 'bootstrap-vue-next';

package/dist/components/components/tag/Tag.vue.d.ts

@@ -0,0 +1,18 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The URL the tag will link to
+     */
+    href: {
+        type: StringConstructor;
+        required: true;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The URL the tag will link to
+     */
+    href: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;

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

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

package/dist/components/components/tag-manager-wrapper/TagManagerWrapper.vue.d.ts

@@ -0,0 +1,48 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Receive an external payload to be pushed through
+     * the data layer by this component
+     */
+    payload: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+}, any, any, {}, {
+    /**
+     * This function receives a payload as props
+     * then replaces all "-" for "_" to match the keys on the templates from iProspect
+     * and after that pushes all the key:values pairs to the store
+     * so any component can retrieve it using the general getter function:
+     * dataLayerStore.getValueFromKey("key_name")
+     */
+    processPayload(payload: any): void;
+}, {
+    computed: {
+        pageUrl: () => string;
+    };
+    data(): {
+        dataLayerLoadConfirmed: boolean;
+        dataLayerStore: any;
+    };
+    mounted(): void;
+    methods: {
+        templateFiller(template: any, values: any): {};
+        createDataLayerObject(type: any, event: any, href: any): void;
+        returnIsoDate(): string;
+        pushToDataLayer(object: any): void;
+        compileFullTemplate(templateValues: any): any;
+        targetText(event: any): any;
+    };
+}, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Receive an external payload to be pushed through
+     * the data layer by this component
+     */
+    payload: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+}>>, {
+    payload: Record<string, any>;
+}, {}>;
+export default _default;

package/dist/components/components/tag-manager-wrapper/index.d.ts

@@ -0,0 +1,2 @@
+export default VsTagManagerWrapper;
+import VsTagManagerWrapper from './TagManagerWrapper.vue';

package/dist/components/components/toggle-button/ToggleButton.vue.d.ts

@@ -0,0 +1,24 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * ID for the toggled element
+     */
+    toggleId: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, {
+    show: boolean;
+}, {}, {
+    toggleAction(): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * ID for the toggled element
+     */
+    toggleId: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    toggleId: string;
+}, {}>;
+export default _default;

package/dist/components/components/toggle-button/index.d.ts

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

package/dist/components/components/tooltip/Tooltip.vue.d.ts

@@ -0,0 +1,39 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The text to display in the tooltip
+     */
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The position of the tooltip
+     * `top|right|left|bottom`
+     */
+    position: {
+        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 text to display in the tooltip
+     */
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The position of the tooltip
+     * `top|right|left|bottom`
+     */
+    position: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => any;
+    };
+}>>, {
+    title: string;
+    position: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,2 @@
+export default VsTooltip;
+import VsTooltip from './Tooltip.vue';