Interaction
Overlay
Toggle

Elements

You can specify elements that listens to event for activation, and targets that gets activated.

The query is inside container, only when specifying elements and targets with id the query is on all the document.

	Syntax	Default / Arguments	Description
Option	`elements:Query`	`'[data-xt-overlay-element]'`	Elements query
Option	`targets:Query`	`'[data-xt-overlay-target]'`	Targets query
Option	`elementsInner:Query`	`false`	Inner elements query, they reflect elements activation
Option	`targetsInner:Query`	`false`	Inner targets query, they reflect targets activation
Option	`exclude:Query`	`false`	Exclude elements and targets if they matches the query

See slider elements exclude for demo.

Group

If you need to toggle multiple elements or targets with the same element or target assign data-xt-group to elements and the associated targets.

	Name	Example	Description
Attribute	`data-xt-group`	`data-xt-group="my-group,another-group"`	Group or multiple groups on elements and targets

	Syntax	Default / Arguments	Description
Option	`groupSeparator:String`	`','`	Separator for multiple groups

You can disable same group elements activation with the option groupElements: false.

	Syntax	Default / Arguments	Description
Option	`groupElements:Boolean`	`true`	Elements activation as group

Class

See toggle class for more info.

You can style and animate class names used by the component.

	Syntax	Default / Arguments	Description
Option	`class:String`	`on`	Class name for activation
Option	`classIn:String`	`in`	Class name for in animation
Option	`classOut:String`	`out`	Class name for out animation
Option	`classDone:String`	`done`	Class name for in animation done
Option	`classInitial:String`	`initial`	Class name for initialization
Option	`classBefore:String`	`dir-before`	Class name for before direction activation
Option	`classAfter:String`	`dir-after`	Class name for after direction activation
Option	`classSkip:Object`	`false`	Skip class activation and deactivation e.g.: `{ elements: true, elementsInner: true, targets: true, targetsInner: true }`

You can set initial activation by adding on to the elements or targets.

Additionally on component initialization the attribute [data-xt-overlay-init] gets added to the object.

Quantity

See toggle quantity for more info.

You can specify min and max concurrent activations. The min option is fulfilled on initialization, the max options deactivates the first activated when max is reached.

	Syntax	Default / Arguments	Description
Option	`min:Number`	`0`	Minimum number of concurrent elements activated
Option	`max:Number`	`1`	Maximum number of concurrent elements activated

Event

See toggle event for more info.

You can specify on and off events for the interactions.

	Syntax	Default / Arguments	Description
Option	`on:String\|false`	`'click'`	List of space separated events to listen for activation
Option	`off:String\|false`	`'click'`	List of space separated events to listen for deactivation
Option	`mouseParent:String\|Boolean`	`false`	For mouse events use element `parentNode` or `closest` query

There some other event options.

	Syntax	Default / Arguments	Description
Option	`eventLimit:Query`	`'.xt-event-limit, .xt-overlay'`	Block on and off events inside selector
Option	`openauto:Boolean`	`true`	Trigger the event `openauto.trigger.xt` inside elements or targets to automatically activate `openauto: true`
Option	`closeauto:Boolean`	`true`	Trigger the event `closeauto.trigger.xt` on window to automatically deactivate current activation if `closeauto: true`
Option	`closeDeep:Query`	`'.xt-dismiss'`	Query Node inside elements or targets to deactivate on click (also nested, can be a inner node)
Option	`closeInside:Query`	`'.xt-backdrop`	Query Node inside elements or targets to deactivate on click (no nested, must be exactly that node)
Option	`closeOutside:Query`	`false`	Query Node on document to deactivate on click (automatically excludes nested inside elements and targets)

If you want a inner node that trigger off on click use .xt-dismiss.

Hash

You can link the activation in the url hash to be linkable and more usable, hash activation has precedence over class activation.

Hash attribute data-xt-hash can be on elements or targets, also hash activates on hash location change.

	Syntax	Default / Arguments	Description
Option	`hash:String\|false`	`[data-xt-hash]`	Link activation in location hash using elements and targets attribute `hash` value

Try the demo on a new page to preview location hash changes.

Navigation and Loop

See toggle navigation and loop for more info.

Class Body

You can set body classes on activation, remember to keep default classBody classes.

	Syntax	Default / Arguments	Description
Option	`classBody:String`	`'xt-scrollbar-overlay'`	Add class to `html` on activation

Scrollto

See scrollto toggle for more info.