Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This shortcode can be used anywhere on the site. It does not need to be initialized.  You simply need to add it to your page to display it.

...


Info
iconfalse

Disclaimers shortcodes are linked to modal windows that are shown upon landing on a particular page, or clicking on a designated element. If the user cancels out, they are redirected to the

...

home page or back to the page that contains the element.  These modals show information related to terms and conditions or disclaimers and acceptance is often required in order for the user to continue.

Table of Contents


General Disclaimer

This shortcode can be used anywhere on the site. It does not need to be initialized.  You simply need to add it to your page to display it.

The available options are: 

Option

Type

Default

Values

Purpose

name

string



This (name) is the disclaimer to show.

...

The name comes from the "systemRegion" value from the Pages table.

dismiss

string

"session"

session, page

...

session = once dismissed, the user will not see again until they log out and log back in

...


page = Each time they reload the page, the disclaimer will appear again

...


show

string

"onload"

onload, {selector}

onload is by default

...

; so the element is shown when the page is loaded

Selector

...

can be used when the intention is to have the disclaimer only

...

show when clicking on the item defined

...

as the selector.

...

As an example

...

, For vehicles

...

the value will

...

be .add-vehicle

...

and the disclaimer will only show

...

when the add-vehicle button is clicked.

Vehicle Disclaimer

...

Code Block
languagexml
titleExample
[disclaimer name=vehicleDisclaimer dismiss=session show=".add-vehicle"]

In this example the disclaimer will show once per session and only when you click the "Add a Vehicle" button. An example is show below.

Image Modified

To update the text for the disclaimer, hover over System Config, and click System Messaging. Click the "Edit" button beside Vehicle Disclaimer.  Update your text and click "Save Messaging".

Locker Disclaimer

...

Code Block
languagexml
titleExample
[disclaimer name=lockersDisclaimer dismiss=never]

In this example the disclaimer will show everytime a user comes to the Locker page. An example is show below.

Image Modified