@danilandreev/material-docs/components/DocsMenuItem/DocsMenuItem.d.ts

material-docs - react framework for easy creating documentation site in material design style.

/*
 * Author: Andrieiev Danil |  danssg08@gmail.com | https://github.com/DanilAndreev
 * Copyright (C) 2020.
 */

/// <reference types="react" />
import Stylable from "../../interfaces/Stylable";
import Containerable from "../../interfaces/Containerable";

export const displayName: string;

export interface DocsMenuItemProps
    extends Stylable, Containerable {
    /**
     * defaultExpanded - if true, panel will be expanded on startup.
     * @default false
     * @type boolean
     */
    defaultExpanded?: boolean;
    /**
     * textPrimary - primary text.
     * @type string
     */
    textPrimary?: string;
    /**
     * textSecondary - secondary text.
     * @type string
     */
    textSecondary?: string;
    /**
     * icon - icon, displayed in left corner.
     * @type JSX.Element
     */
    icon?: JSX.Element;

    /**
     * onClick - callback, will be triggered on onclick event handling.
     * @function
     * @param event
     */
    onClick?(event: any): void;

    /**
     * page - page name for redirecting or object structure for routing-manager changeRoute.
     * @see https://github.com/DanilAndreev/routing-manager/wiki/changeRoute
     * @type string
     */
    page?: string | any;
    /**
     * link - link to the page, which includes groups. If defined - will be used with highest priority.
     * @type string
     */
    link?: string;
    /**
     * isCurrent - if true, button will be active. Used when displayed page, connected to this menu item.
     * @default false
     * @type function | boolean
     */
    isCurrent?: ((routeParams, pageRoute, page) => boolean) | boolean,
    /**
     * dense - if true, compact vertical padding designed for keyboard and mouse input will be used for the list and list items. The prop is available to descendant components as the dense context.
     * @default false
     * @type boolean
     */
    dense?: boolean;
    /**
     * nesting - system information about component nesting.
     * @type number
     * @default 0
     * @ignore
     */
    nesting?: number;
}

/**
 * DocsMenuItem - component, used in DocsMenu component to create menu items.
 * @param {DocsMenuItemProps} props
 * @constructor
 * @see http://material-docs.com/component-apis/docsmenuitem
 * @example
 * <DocsMenu>
 *     <DocsMenuItem textPrimary={"drop down"}>
 *         <DocsMenuItem textPrimary="Page 1 - best page" textSecondary="Hello, its me!" page="page1"/>
 *         <DocsMenuItem textPrimary="Page 2 - best page" textSecondary="Hello, its me!" page="page2"/>
 *     </DocsMenuItem>
 *     <DocsMenuItem textPrimary="Last page" textSecondary="I am the last one" page="page3"/>
 * </DocsMenu>
 */
export default function DocsMenuItem(props: DocsMenuItemProps): JSX.Element;