Global Config

Some options only make sense at a global level, rather than at a single reveal instance, such as responsiveness handling. Here, you can learn about global configuration options and how to leverage them to fine-tune the reveal experience to your liking.

once

type: boolean
default: false
API: setOnce

Whether the reveal effect runs only once (i.e. it doesn’t re-run on page reload).

responsive

type: Responsive

Specifies how the library handles responsiveness. It can be used to enable/disable the reveal effect on some devices.

mobile

type: DeviceConfig

Configuration of mobile devices.

enabled

type: boolean
default: true

Whether the reveal effect is performed on mobile devices.

breakpoint

type: number
default: 425

The max viewport width of mobile devices.

tablet

type: DeviceConfig

Configuration of tablet devices.

enabled

type: boolean
default: true

Whether the reveal effect is performed on tablet devices.

breakpoint

type: number
default: 768

The max viewport width of tablet devices.

laptop

type: DeviceConfig

Configuration of laptop devices.

enabled

type: boolean
default: true

Whether the reveal effect is performed on laptop devices.

breakpoint

type: number
default: 1440

The max viewport width of laptop devices.

desktop

type: DeviceConfig

Configuration of desktop devices.

enabled

type: boolean
default: true

Whether the reveal effect is performed on desktop devices.

breakpoint

type: number
default: 2560

The max viewport width of desktop devices.