Metronic

The Ultimate Bootstrap & Angular 6 Admin Theme Framework For Next Generation Applications

Offcanvas

Overview

mOffcanvas is a Metronic's custom plugin defined in [root]/theme/default/src/js/framework/components/general/offcanvas.jsjs.

Initialization

First parameter is the id, class, or tag of the HTML element. The second parameter is for the options.

horMenuOffcanvas = new mOffcanvas('m_header_menu', {
    baseClass: 'm-aside-left--offcanvas-default',
    overlay: true,
    closeBy: 'm_aside_left_close_btn',
    toggleBy: {
        target: 'm_aside_left_offcanvas_toggle',
        state: 'm-brand__toggler--active'
    }
});

Options

var options = {
    baseClass: 'm-aside-left--offcanvas-default',
    overlay: true,
    closeBy: 'm_aside_left_close_btn',
    toggleBy: {
        target: 'm_aside_left_offcanvas_toggle',
        state: 'm-brand__toggler--active'
    }
}
Field Type Description
overlay boolean

Enable/disable offcanvas overlay

Sample
overlay: true
baseClass string

Set the base class for the offcanvas

Sample
baseClass: 'm-aside-header-menu-mobile'
closeBy string

Define the element for the off canvas to be cloased when this element is clicked

Sample
closeBy: 'm_aside_header_menu_mobile_close_btn'
toggleBy object

Define which element for the toggle and set the active state class name

Sample
toggleBy: {
    target: 'm_aside_header_menu_mobile_toggle',
    state: 'm-brand__toggler--active'
}

API Methods

Method Description
setDefaults(options)

Set default options

Input Parameters
Name Type Description
options object

A new options object for the menu

show()

Set show dropdown

hide()

Set hide dropdown

on(name, handler)

Register event

Input Parameters
Name Type Description
name string

Unique event name

handler function

Callback function handler for the event

one(name, handler)

Register event to be run once

Input Parameters
Name Type Description
name string

Unique event name

handler function

Callback function handler for the event

I run a team of 20 product managers, developers, QA and UX resources. Previously we designed everything ourselves. For our newest platform we tried out Metronic. I cannot overestimate the impact Metronic has had. It's accelerated development 3x and reduced QA issues by 50%. If you add up the reduced need for design time/resources, the increase in dev speed and the reduction in QA, it's probably saved us $100,000 on this project alone, and I plan to use it for all platforms moving forward.
The flexibility of the design has also allowed us to put out a better looking & working platform and reduced my headaches by 90%. Thank you KeenThemes! Jonathan Bartlett, Metronic Customer

Powerful Framework

Everything within Metronic is customizable globally to provide limitless unique styled projects

Multi Demo

Choose a perfect design for your next project among hundreds of demos

Limitless Components

A huge collection of components to power your application with the latest UI/UX trands

Angular 6 Support

Enterprise ready Angular 6 integration with built-in authentication module and many more

Bootstrap 4

Metronic deeply customizes Bootstrap with native look and feel

Exclusive Datatable Plugin

Our super sleek and intuitive Datatable comes packed with all advanced CRUD features

60,000+ Strong

Metronic is the only theme trusted by over 60,000 developers world wide

Continuous Updates

Lifetime updates with new demos and features is guaranteed

Quality Code

Metronic is writer with a code structure that all developers will be able to pick up easily and fall in love

The Ultimate Bootstrap Admin Theme Trusted By Over 60,000 Developers World Wide