API Docs for:
Show:

Navigations.OffCanvasMenuLevel Class

Module: Navigations

Item Index

Methods

close

() Undefined

Closes the navigation level

Returns:

Undefined:

Nothing

Example:

import OffCanvasMenuLevel from './navigations/offcanvas/js/offcanvas';

const myOffCanvasLevel = OffCanvasMenuLevel.of('[data-widget=OffCanvasMenuLevel]');
myOffCanvasLevel.render().startUp();
myOffCanvasLevel.open();

of

(
  • node
)
OffCanvasMenuLevel static

Creates a new OffCanvasMenuLevel instance without the "new" keyword but does not initialize it

Parameters:

  • node Node | String | Configs

    Node, CSS selector or configuration object

Returns:

OffCanvasMenuLevel:

A new instance

Example:

import OffCanvasMenuLevel from './navigations/offcanvas/js/offcanvaslevel';

const myLevel = OffCanvasMenuLevel.of('[data-widget=OffCanvasMenuLevel]');
myLevel.render().startUp();

open

() Undefined

Opens the navigation level

Returns:

Undefined:

Nothing

Example:

import OffCanvasMenuLevel from './navigations/offcanvas/js/offcanvas';

const myOffCanvasLevel = OffCanvasMenuLevel.of('[data-widget=OffCanvasMenuLevel]');
myOffCanvasLevel.render().startUp();
myOffCanvasLevel.open();

render

() This

Does nothing

Returns:

This:

The instance

setOverflow

() Deferred

Function to manage overflow on opening / closing Scrolls level to top without flickering caused by scrollbar

Returns:

Deferred:

deferred, that is being resolved after the overlay management is finished

Example:

import OffCanvasMenuLevel from './navigations/offcanvas/js/offcanvas';

const myOffCanvasLevel = OffCanvasMenuLevel.of('[data-widget=OffCanvasMenuLevel]');
myOffCanvasLevel.render().startUp();
myOffCanvasLevel.open();

startUp

() Undefined

Attaches all eventlisteners to the instance

Returns:

Undefined:

Nothing

Example:

import OffCanvasMenuLevel from './navigations/offcanvas/js/offcanvaslevel';

const myLevel = OffCanvasMenuLevel.of('[data-widget=OffCanvasMenuLevel]');
myLevel.render().startUp();