@paperbits/core/menu/menuContract.ts

Paperbits core components.

import { Contract } from "@paperbits/common";
import { SecurityContract } from "@paperbits/common/security";
import { LocalStyles } from "@paperbits/common/styles";

/**
 * Menu widget contract.
 */
export interface MenuContract extends Contract {
    /**
     * Root navigation item key.
     */
    navigationItemKey?: string;

    /**
     * Min heading level to display in menu.
     */
    minHeading?: number;

    /**
     * Max heading level to display in menu.
     */
    maxHeading?: number;

    /**
     * Menu layout key;
     */
    layout?: string;

    /**
     * @deprecated Keys of user roles.
     */
    roles?: string[];

    /**
     * Menu local styles.
     */
    styles: LocalStyles;

    /**
     * Security settings.
     */
     security?: SecurityContract;
}