Settings API Reference
Optional Settings
All settings, and indeed the entire settings object, are optional.
Selected Categories
For v1.0.0 of the Embedded Web Directory, categories that are shown may only be customised using the category IDs, not by name (These should be requested from Acquire Digital as required).
Type: Array.
Pass an array of category IDs for parent categories that you wish to show.
This setting can also be used in combination with excludedSubcategories to show only a single subcategory. To achieve this, pass the parent category that it belongs to, then use the excludedSubcategories setting to exclude everything except the subcategory you wish to show.
Default Behaviour
Without this setting (or also if you pass an empty array), all categories and their destinations will be shown in the component.
Key: "selectedCategories"
Example Value: [12, 11, 10]
Excluded Subcategories
ype: Array.
Pass an array of subcategory IDs that you do not wish to show.
Default Behaviour
Without this setting, all subcategories and their destinations will be shown in the component.
Key: "excludedSubcategories"
Example Value: [10, 20, 30, 40, 50]
Show Empty Categories
Type: Boolean.
Pass a boolean to tell the component whether or not to show categories that do not have any destinations.
Default Behaviour
Without this setting, the default behaviour is equivalent to passing false - empty categories will not be shown.
Key: "showEmptyCategories"
Example Value: true
Map URL
Type: String.
Pass the URL of the page of your website where the Wayfinder web map is embedded. This URL will be used for the 'View on map' link on the destination view.
Default Behaviour
Without this setting the view on map link will not render on the destination view.
Key: "mapUrl"
Example Value: https://www.example.com
Twenty Four Hour Time Format
Type: Boolean.
Pass a boolean to tell the component whether or not to show opening times in the card headers in 24 hour format.
Default Behaviour
Without this setting, the default behaviour is equivalent to passing false - times will be shown in 12 hour format e.g. 2:00PM instead of 14:00.
Key: "twentyFourHourTimeFormat"
Example Value: true
Buildings Filter Default Option
Type: String.
Pass the text you would like to show as the default option in the buildings filter.
Default Behaviour
Without this setting the default value Show All will be used.
Key: "buildingsFilterDefaultOption"
Example Value: Show All
Buildings Filter Default Label
Type: String.
Pass the text you would like to show as the label for the buildings filter.
Default Behaviour
Without this setting the default value Filter by Level will be used.
Key: "buildingsFilterDefaultLabel"
Example Value: Filter by Level
Scroll Behavior
ype: String.
"smooth" or "instant" or "auto"
The behaviour of programmatic scrolls. Consistent with window.scrollTo behaviour options.
Default Behaviour
To preserve backward-compatibility, the default is smooth .
Key: "scrollBehavior" NOTE: Spelling is american for consistency with web standards.