@danilandreev/material-docs/components/Code/Code.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 CodeProps
    extends Stylable, Containerable {
    /**
     * theme - highlighting and background styling type.
     * @default "light"
     * @type string
     */
    theme?: "light" | "dark" | "darcula";
    /**
     * language - source code language name to highlight syntax.
     * @default javascript
     * @type string
     */
    language?: "1c" | "abnf" | "accesslog" | "actionscript" | "ada" | "angelscript" | "apache" | "applescript" | "arcade" |
        "arduino" | "armasm" | "asciidoc" | "aspectj" | "autohotkey" | "autoit" | "avrasm" | "awk" | "axapta" | "bash" |
        "basic" | "bnf" | "brainfuck" | "c-like" | "c" | "cal" | "capnproto" | "ceylon" | "clean" | "clojure-repl" | "clojure" |
        "cmake" | "coffeescript" | "coq" | "cos" | "cpp" | "crmsh" | "crystal" | "csharp" | "csp" | "css" | "d" | "dart" |
        "delphi" | "diff" | "django" | "dns" | "dockerfile" | "dos" | "dsconfig" | "dts" | "dust" | "ebnf" | "elixir" |
        "elm" | "erb" | "erlang-repl" | "erlang" | "excel" | "fix" | "flix" | "fortran" | "fsharp" | "gams" | "gauss" |
        "gcode" | "gherkin" | "glsl" | "gml" | "go" | "golo" | "gradle" | "groovy" | "haml" | "handlebars" | "haskell" |
        "haxe" | "hsp" | "htmlbars" | "http" | "hy" | "inform7" | "ini" | "irpf90" | "isbl" | "java" | "javascript" |
        "jboss-cli" | "json" | "julia-repl" | "julia" | "kotlin" | "lasso" | "latex" | "ldif" | "leaf" | "less" | "lisp" |
        "livecodeserver" | "livescript" | "llvm" | "lsl" | "lua" | "makefile" | "markdown" | "mathematica" | "matlab" |
        "maxima" | "mel" | "mercury" | "mipsasm" | "mizar" | "mojolicious" | "monkey" | "moonscript" | "n1ql" | "nginx" |
        "nim" | "nix" | "nsis" | "objectivec" | "ocaml" | "openscad" | "oxygene" | "parser3" | "perl" | "pf" | "pgsql" |
        "php-template" | "php" | "plaintext" | "pony" | "powershell" | "processing" | "profile" | "prolog" | "properties" |
        "protobuf" | "puppet" | "purebasic" | "python-repl" | "python" | "q" | "qml" | "r" | "reasonml" | "rib" | "roboconf" |
        "routeros" | "rsl" | "ruby" | "ruleslanguage" | "rust" | "sas" | "scala" | "scheme" | "scilab" | "scss" | "shell" |
        "smali" | "smalltalk" | "sml" | "sqf" | "sql" | "stan" | "stata" | "step21" | "stylus" | "subunit" | "swift" |
        "taggerscript" | "tap" | "tcl" | "thrift" | "tp" | "twig" | "typescript" | "vala" | "vbnet" | "vbscript-html" |
        "vbscript" | "verilog" | "vhdl" | "vim" | "x86asm" | "xl" | "xml" | "xquery" | "yaml" | "zephir";
    /**
     * children - your code.
     * @type string
     */
    children?: string,
}

/**
 * Code - react component, designed to display and highlight code.
 * @param {CodeProps} props
 * @constructor
 * @see http://material-docs.com/component-apis/code
 * @example
 * <Code language="code language" theme="darcula">
 *     ...your code...
 * </Code>
 */
export default function Code(props: CodeProps): JSX.Element;