@visitscotland/component-library 2.0.6 → 3.0.0

package/dist/components/components/map-with-sidebar/MapWithSidebar.vue.d.ts

@@ -0,0 +1,366 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Heading for the categories view
+     */
+    categoryHeading: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Filter categories
+     */
+    filters: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Data for individual places
+     */
+    placesData: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Unique ID for the map - used to
+     * differentiate between multiple map
+     * instances in the Pinia store
+     */
+    mapId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Level of the heading to be used in the
+     * panel (to allow main heading in section)
+     */
+    mainHeadingExists: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The ID of the currently selected item
+     */
+    initialSelected: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Data for the toggle buttons
+     */
+    toggleData: {
+        type: ArrayConstructor;
+        default: () => any[];
+    };
+    /**
+     * Data for the toggle buttons
+     */
+    buttonsLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for the 'clear selection' button
+     */
+    clearSelectionText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text for the 'apply filters' button
+     */
+    applyFiltersText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Endpoint for getting place details
+     */
+    detailsEndpoint: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Bounds if map needs to show a specific area
+     */
+    regionBounds: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+    /**
+     * Text for clearing filters - to be passed
+     * to buttons component
+     */
+    clearFiltersText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text for applied filters - to be passed
+     * to buttons component
+     */
+    filtersAppliedText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * ID for map's place
+     */
+    placeId: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Text to show on map propmpting user to filter results
+     */
+    mapFilterMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text to show on map when there are no results
+     */
+    mapNoResultsMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * A message that appears at the bottom
+     * of the side panel
+     */
+    panelMessage: {
+        type: StringConstructor;
+        default: any;
+    };
+}, any, {
+    panelVisible: boolean;
+    selectedCategory: string;
+    filterCategories: unknown[];
+    selectedItem: any;
+    activePins: unknown[];
+    currentlyHovered: string;
+    showRegions: boolean;
+    regions: any[];
+    subCatList: any;
+    selectedToggle: string;
+    currentEndpointData: any[];
+    mapStatus: string;
+    panelStatus: string;
+    mapReady: boolean;
+    showPanelMessage: any;
+    currentPanelEndpointFilters: string;
+    totalEndpointPins: number;
+    focussedListItem: number;
+    resetZoom: boolean;
+    currentStage: number;
+    selectedSubCategory: any;
+}, {
+    infoMessage(): string;
+    subCatActiveFilters: () => any;
+    mapDisplayClass(): "" | "d-none d-lg-block";
+    panelDisplayClass(): "" | "d-none d-lg-block";
+    regionsData(): any;
+}, {
+    openMenu(): void;
+    /**
+     * Close the side panel
+     */
+    closePanel(): void;
+    /**
+     * Open the side panel
+     */
+    openPanel(): void;
+    /**
+     * Show an item's details
+     */
+    showDetail(feature: any): void;
+    /**
+     * Sets the currently chosen category
+     */
+    setCategory(cat: any): void;
+    /**
+     * Sets a subcategory
+     */
+    setSubCategory(subcat: any): void;
+    /**
+     * Filters subcategories
+     */
+    filterSubCategories(filters: any): void;
+    /**
+     * Makes a call to the API to get marker data for
+     * the current subcategory
+     */
+    getSubcatMarkerData(endpointFilters: any): void;
+    /**
+     * Makes a call to the endpoint in the subcategory data which
+     * provides a random 24 items for the side panel
+     */
+    getSubcatPanelData(endpointFilters: any, page: any): void;
+    /**
+     * Sets the current stage
+     */
+    setStage(num: any): void;
+    /**
+     * Updates active pins for map
+     */
+    filterPlaces(id: any): void;
+    /**
+     * Load more places from endpoint
+     */
+    loadMorePlaces(page: any): void;
+    /**
+     * Show all pins, remove regions
+     */
+    showAllPlaces(): void;
+    /**
+     * When toggle is changed, set appropriate category
+     */
+    onToggleChanged(category: any): void;
+    /**
+     * Set whether or not map is ready to use
+     */
+    setMapReady(val: any): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Heading for the categories view
+     */
+    categoryHeading: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Filter categories
+     */
+    filters: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Data for individual places
+     */
+    placesData: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    /**
+     * Unique ID for the map - used to
+     * differentiate between multiple map
+     * instances in the Pinia store
+     */
+    mapId: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Level of the heading to be used in the
+     * panel (to allow main heading in section)
+     */
+    mainHeadingExists: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The ID of the currently selected item
+     */
+    initialSelected: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Data for the toggle buttons
+     */
+    toggleData: {
+        type: ArrayConstructor;
+        default: () => any[];
+    };
+    /**
+     * Data for the toggle buttons
+     */
+    buttonsLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Text for the 'clear selection' button
+     */
+    clearSelectionText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text for the 'apply filters' button
+     */
+    applyFiltersText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Endpoint for getting place details
+     */
+    detailsEndpoint: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Bounds if map needs to show a specific area
+     */
+    regionBounds: {
+        type: ObjectConstructor;
+        default: () => void;
+    };
+    /**
+     * Text for clearing filters - to be passed
+     * to buttons component
+     */
+    clearFiltersText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text for applied filters - to be passed
+     * to buttons component
+     */
+    filtersAppliedText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * ID for map's place
+     */
+    placeId: {
+        type: StringConstructor;
+        default: any;
+    };
+    /**
+     * Text to show on map propmpting user to filter results
+     */
+    mapFilterMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Text to show on map when there are no results
+     */
+    mapNoResultsMessage: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * A message that appears at the bottom
+     * of the side panel
+     */
+    panelMessage: {
+        type: StringConstructor;
+        default: any;
+    };
+}>>, {
+    initialSelected: string;
+    buttonsLabel: string;
+    categoryHeading: string;
+    panelMessage: string;
+    mainHeadingExists: boolean;
+    toggleData: unknown[];
+    detailsEndpoint: string;
+    regionBounds: Record<string, any>;
+    placeId: string;
+}, {}>;
+export default _default;

package/dist/components/components/map-with-sidebar/components/MapWithSidebarButtons.vue.d.ts

@@ -0,0 +1,39 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Data for component content
+     */
+    contentData: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * If content is filtered by subcategory
+     */
+    filterCount: {
+        type: NumberConstructor;
+        default: any;
+    };
+}, any, any, {
+    websiteDataExists(): boolean;
+}, {
+    filtersClick(): void;
+    clearFiltersClick(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Data for component content
+     */
+    contentData: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * If content is filtered by subcategory
+     */
+    filterCount: {
+        type: NumberConstructor;
+        default: any;
+    };
+}>>, {
+    filterCount: number;
+}, {}>;
+export default _default;

package/dist/components/components/map-with-sidebar/components/MapWithSidebarCategory.vue.d.ts

@@ -0,0 +1,57 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Name of category
+     */
+    categoryName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Category type - for use with markers
+     * and data
+     */
+    type: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * If the category has a subcategory
+     */
+    hasSubCat: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, {
+    isHovered: boolean;
+}, {}, {
+    /**
+     * Emits category type
+     */
+    selectCategory(type: any): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Name of category
+     */
+    categoryName: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Category type - for use with markers
+     * and data
+     */
+    type: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * If the category has a subcategory
+     */
+    hasSubCat: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    hasSubCat: boolean;
+}, {}>;
+export default _default;

package/dist/components/components/map-with-sidebar/components/MapWithSidebarControls.vue.d.ts

@@ -0,0 +1,16 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {
+    isDisabled: boolean;
+}, {
+    getSubcatFilters: () => any;
+}, {
+    /**
+     * Clears all selected checkboxes
+     */
+    clearSelection(): void;
+    /**
+     * Emits instuction to submit data
+     */
+    submitCheckboxes(): void;
+    disableSubmitButton(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

package/dist/components/components/map-with-sidebar/components/MapWithSidebarDetail.vue.d.ts

@@ -0,0 +1,36 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Data for component content
+     */
+    contentData: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Heading level - to allow sequential heading
+     */
+    headingLevel: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    showTitle(): boolean;
+}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Data for component content
+     */
+    contentData: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Heading level - to allow sequential heading
+     */
+    headingLevel: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    headingLevel: string;
+}, {}>;
+export default _default;

package/dist/components/components/map-with-sidebar/components/MapWithSidebarListItem.vue.d.ts

@@ -0,0 +1,65 @@
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * Name of item
+     */
+    itemData: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /** If the data source is from an API endpoint */
+    fromEndpoint: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * If the component should be focussed on mount
+     */
+    focussed: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, {
+    formattedData: {};
+}, {
+    highlightedPlace: () => any;
+    isActive(): boolean;
+}, {
+    /**
+     * Emits an event with the ID of the chosen
+     * item as the payload
+     */
+    showItemDetail(feature: any): void;
+    /**
+     * Emits an event with the ID of the chosen
+     * item on hover
+     */
+    itemHover(feature: any): void;
+    /**
+     * Formats API data to match internal data
+     */
+    formatApiData(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Name of item
+     */
+    itemData: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /** If the data source is from an API endpoint */
+    fromEndpoint: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+    * If the component should be focussed on mount
+     */
+    focussed: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    fromEndpoint: boolean;
+    focussed: boolean;
+}, {}>;
+export default _default;