mmenu-js/src/core/oncanvas/_typings.d.ts

The best javascript plugin for app look-alike on- and off-canvas menus with sliding submenus for your website and webapp.

/** An object with any value. */
interface mmLooseObject {
    [key: string]: any;
}

/** An object with string values. */
interface mmStringObject {
    [key: string]: string;
}

/** An object with boolean values. */
interface mmBooleanObject {
    [key: string]: boolean;
}

/** An object with function values. */
interface mmFunctionObject {
    [key: string]: Function;
}

/** An object with even listeners. */
interface mmEventObject {
    [key: string]: EventListener;
}

/** An object with HTMLElement values. */
interface mmHtmlObject {
    [key: string]: HTMLElement;
}

/** The menu API. */
interface mmApi {
    bind: Function;
    initPanel: Function;
    openPanel: Function;
    closePanel: Function;
    closeAllPanels: Function;
    setSelected: Function;

    //	offCanvas add-on
    open: Function;
    close: Function;
    setPage: Function;

    //	searchfield add-on
    search: Function;
}

//	Class methods interfaces.
interface mmMethodUniqueid {
    (): string;
}
interface mmMethodI18n {
    (text?: object, language?: string): object;
    (text?: string, language?: string): string;
    (text?: undefined, language?: string): object;
}

/**	Options for the menu. */
interface mmOptions {
    /** A collection of extensions to enable for the menu. */
    extensions?: mmOptionsExensions | string[];

    /** A collection of functions to hook into the API methods before the menu is initialised. */
    hooks?: mmFunctionObject;

    /** Options for the navbar. */
    navbar?: mmOptionsNavbar;

    /** Options for clicking a listitem. */
    onClick?: mmOptionsOnclick;

    /** Whether or not submenus should come sliding in from the right. */
    slidingSubmenus?: boolean;

    /** A collection of framework wrappers to enable for the menu. */
    wrappers?: string[];

    //	Core add-ons

    /** Options for the off-canvas add-on. */
    offCanvas?: mmOptionsOffcanvas;

    /** Options for the screen reader add-on. */
    screenReader?: mmOptionsScreenreader;

    /** Options for the scroll bug fix add-on. */
    scrollBugFix?: mmOptionsScrollbugfix;

    //	Add-ons

    /** Options for the auto height add-on. */
    autoHeight?: mmOptionsAutoheight;

    /** Options for the back button add-on. */
    backButton?: mmOptionsBackbutton;

    /** Options for the columns add-on. */
    columns?: mmOptionsColumns;

    /** Options for the counters add-on. */
    counters?: mmOptionsCounters;

    /** Options for the dividers add-on. */
    dividers?: mmOptionsDividers;

    /** Options for the drag add-on. */
    drag?: mmOptionsDrag;

    /** Options for the dropdown add-on. */
    dropdown?: mmOptionsDropdown;

    /** Options for the iconbar add-on. */
    iconbar?: mmOptionsIconbar;

    /** Options for the icon panels add-on. */
    iconPanels?: mmOptionsIconpanels;

    /** Options for the keyboard navigation add-on. */
    keyboardNavigation?: mmOptionsKeyboardnavigation;

    /** Options for the lazy submenus add-on. */
    lazySubmenus?: mmOptionsLazysubmenus;

    /** List of navbar options for the navbars add-on. */
    navbars?: mmOptionsNavbarsNavbar[];

    /** Options for the page scroll add-on. */
    pageScroll?: mmOptionsPagescroll;

    /** Options for the searchfield add-on. */
    searchfield?: mmOptionsSearchfield;

    /** Options for the section indexer add-on. */
    sectionIndexer?: mmOptionsSectionindexer;

    /** Options for the set selected add-on. */
    setSelected?: mmOptionsSetselected;

    /** Options for the sidebar add-on. */
    sidebar?: mmOptionsSidebar;
}

/**	Extensions for the menu. */
interface mmOptionsExensions {
    [key: string]: mmOptionsExensions | string[];
}

/**	Navbar options for the menu. */
interface mmOptionsNavbar {
    /** Whether or not to add a navbar above the panels. */
    add?: boolean;

    /** Whether or not the navbars should be sticky. */
    sticky?: boolean;

    /** The title above the panels. */
    title?: string;

    /** The type of link to set for the title. */
    titleLink?: 'parent' | 'anchor' | 'none';
}

/**	onClick options for the menu. */
interface mmOptionsOnclick {
    /** Whether or not the menu should close after clicking a link inside it. */
    close?: boolean;

    /** Whether or not to prevent the default behavior for the clicked link. */
    preventDefault?: boolean;

    /** Whether or not the clicked link should appear as "selected". */
    setSelected?: boolean;
}

/**	Configuration for the menu. */
interface mmConfigs {
    /** Object with classnames to refactor. */
    classNames?: mmLooseObject;

    /** The language to translate the menu to. */
    language?: 'en' | 'nl' | 'de' | 'ru' | 'fa';

    /** The number of milliseconds between opening/closing the menu and panels, needed to force CSS transitions. */
    openingInterval?: number;

    /** List of possible node-type of panels. */
    panelNodetype?: string[];

    /** The number of milliseconds used in the CSS transitions. */
    transitionDuration?: number;

    //	Core add-ons

    /** Configuration for the off-canvas add-on. */
    offCanvas?: mmConfigsOffcanvas;

    /** Configuration for the screen reader add-on. */
    screenReader?: mmConfigsScreenreader;

    //	Add-ons

    /** Configuration for the dropdown add-on. */
    dropdown?: mmConfigsDropdown;

    /** Configuration for the fixed elements add-on. */
    fixedElements?: mmConfigsFixedelements;

    /** Configuration for the navbars add-on. */
    navbars?: mmConfigsNavbars;

    /** Configuration for the page scroll add-on. */
    pageScroll?: mmConfigsPagescroll;

    /** Configuration for the searchfield add-on. */
    searchfield?: mmConfigsSearchfield;
}

/**	Arguments for the onClick handlers. */
interface mmClickArguments {
    /** Whether or not the anchor is inside the menu. */
    inMenu: boolean;

    /** Whether or not the anchor is inside a listview. */
    inListview: boolean;

    /** Whether or not the anchor references to an external page. */
    toExternal: boolean;
}