@danilandreev/material-docs/interfaces/SearchDataItem.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.
 */

export default interface SearchDataItem {
    /**
     * redirect - url for redirect or callback function on redirect. Function will be called on list item key press.
     * Also redirect can be object type for routing-manager changeRoute.
     * @see https://github.com/DanilAndreev/routing-manager/wiki/changeRoute
     * @type string | function | object
     */
    redirect: string | (() => void) | object;
    /**
     * label - page short overview.
     * @type string
     */
    label: string;
    /**
     * description - page summary.
     * @type string
     */
    description?: string;
    /**
     * tags - key words for search.
     * @type array
     */
    tags?: string[];
}