@danilandreev/material-docs/components/CodeSpan/CodeSpan.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 CodeSpanProps
    extends Stylable, Containerable {
    /**
     * color - background color of the inline code block.
     * @type string
     * @default "default"
     */
    color?: "default" | "primary" | "secondary" | "grey";
    /**
     * text - text color of code.
     * @type string
     * @default "inherit"
     */
    text?: "white" | "black" | "inherit";
}

/**
 * CodeSpan - react component, designed to create inline code spans.
 * @param {CodeSpanProps} props
 * @constructor
 * @see http://material-docs.com/component-apis/codespan
 * @example
 * I am <CodeSpan>code span</CodeSpan> in the text.
 */
export default function CodeSpan(props: CodeSpanProps): JSX.Element;