@danilandreev/material-docs/components/Markdown/Markdown.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 MarkdownProps
    extends Stylable, Containerable {
    /**
     * inline - if true, markdown container will be inline.
     * @type boolean
     * @default false
     */
    inline?: boolean;
    /**
     * data - data structure, used as storage to store components or other data, which can not describe via markdown.
     * @default {}
     * @type object
     * @example
     * You can use data prop to provide your markdown with DemoWithCode demo element.
     */
    data?: object;
    /**
     * children - children of an element. Should contain markdown text.
     * @type string | any
     */
    children?: string | string[];
}

/**
 * Markdown - react component, designed to provide markdown based layout generation.
 * @param {MarkdownProps} props
 * @constructor
 * @see http://material-docs.com/component-apis/markdown
 * @example
 * <Markdown>
 *     # I am header 1
 *     ## And I am header 2
 * </Markdown>
 */
export default function Markdown(props: MarkdownProps): JSX.Element;