@danilandreev/material-docs/components/DocsLayout/DocsLayout.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 Containerable from "../../interfaces/Containerable";
import SearchDataItem from "../../interfaces/SearchDataItem";
import Lang from "../../interfaces/Lang";
import AppBarAction from "../../interfaces/AppBarAction";

export const displayName: string;

export interface DocsLayoutProps
    extends Containerable {
    /**
     * searchData - array of SearchDataItem items to do search from.
     * @type SearchDataItem[]
     */
    searchData?: SearchDataItem[];
    /**
     * noGenerateAutoSearch - if true, Material Docs will not generate search items from pages automatically.
     * @type boolean
     * @default false
     */
    noGenerateAutoSearch?: boolean;
    /**
     * defaultLang - default language settings.
     * @type Lang
     */
    defaultLang?: Lang;
    /**
     * langs - list of all available langs.
     * @type Lang[]
     */
    langs?: Lang[];

    /**
     * onHelpToTranslate - function, called on help to translate button click. If not defined - button will not be rendered.
     * @function
     * @param {Lang} lang
     */
    onHelpToTranslate?(lang: Lang): void;

    /**
     * router - react-router-dom Router type.
     * @type string
     * @default browser-router
     * @see https://reactrouter.com/web/api/BrowserRouter
     * @see https://reactrouter.com/web/api/HashRouter
     */
    router?: "hash-router" | "browser-router";
    /**
     * basename - basename param for react-router-dom Router.
     * @type string
     * @see https://reactrouter.com/web/api/BrowserRouter
     * @see https://reactrouter.com/web/api/HashRouter
     */
    basename?: string;
    /**
     * mask - mask for routing-manager ChangeRouteProvider routeMask property.
     * @type string
     * @default "/*page"
     * @see https://github.com/DanilAndreev/routing-manager/wiki/ChangeRouteProvider#routemask
     */
    mask?: string;
    /**
     * noSearchField - if true, search field will not be displayed.
     * @default false
     * @type boolean
     */
    noSearchField?: boolean;
    /**
     * noLanguageSelector - if true, language selector will not be displayed.
     * @default false
     * @type boolean
     */
    noLanguageSelector?: boolean;
    /**
     * actions - an array of actions. Will be displayed in material-ui IconButton components in Toolbar component inside AppBar.
     * @default []
     * @type AppBarAction[]
     */
    actions?: AppBarAction[];
    /**
     * author - author of the docs. Needs for metadata.
     * @type string
     */
    author?: string;
    /**
     * keywords - keywords of the docs for search engines. Needs for metadata.
     * @type string[]
     */
    keywords?: string[];
    /**
     * description - description of the docs. Needs for metadata.
     * @type string
     */
    description?: string;
    /**
     * name - name of the docs. Needs for metadata.
     * @type string
     */
    name?: string;
    /**
     * version - version of the docs. Needs for metadata.
     * @type string
     */
    version?: string;
    /**
     * logo - path to logo image, will be displayed in drawer near name and version.
     * @type string
     */
    logo?: string;
    /**
     * onNameClick - callback, designed to handle click on docs name in drawer badge.
     * @function
     * @param {Event} event
     * @return void
     */
    onNameClick?(event: any): void;
    /**
     * onVersionClick - callback, designed to handle click on docs version in drawer badge.
     * @function
     * @param {Event} event
     * @return void
     */
    onVersionClick?(event: any): void;
}

/**
 * DocsLayout - main component of MaterialDocs.
 * @param {DocsLayoutProps} props
 * @constructor
 * @see https://material-docs.com/component-apis/docslayout
 * @example
 * <DocsLayout>
 *     <DocsMenu>
 *         ...menu items...
 *     </DocsMenu>
 *     <DocsPages>
 *         ...pages...
 *     </DocsPages>
 * </DocsLayout>
 */
export default function DocsLayout(props: DocsLayoutProps): JSX.Element;