Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 1.57 KB

template.md

File metadata and controls

44 lines (36 loc) · 1.57 KB
Raw

Custom SilverStripe Template

There are some caveats when creating a custom template. These do not need to be grouped in a parent container, but custom css is recomended if they are not.

Loading Container

The loading container must always be included as this is where the initial react render is done. It must always have a class of locator-loading.

<div class="locator-loading"></div>

Search Container

The search container is optional. It must always have a class of locator-search.

<div class="locator-search"></div>

List Container

The search container is optional. It must always have a class of locator-list.

<div class="locator-list"></div>

Map Container

The map container is optional. It must always have a class of locator-map.

<div class="locator-map"></div>

Hiding the map and list on initial load

To hide the map conatiner and the list on initial page load -hidden can be appended to their classes. They will still show on search and when the page is loaded with a search in the url.

<div class="locator-list-hidden"></div>
<div class="locator-map-hidden"></div>

Required Javascript

To make the react locator work some javascript is required.

  • silverstripe/admin: client/dist/js/vendor.js
  • silverstripe/admin: client/dist/js/bundle.js
  • dynamic/silverstripe-locator-react: client/dist/js/main.js

These can be included in the template, or in a controller extension. If custom components or reducers are required it is recommended to do requirements in a controller extension.