@types/react-markings

Installation

npm install --save @types/react-markings

Summary

This package contains type definitions for react-markings (https://github.com/Thinkmill/react-markings#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-markings.

index.d.ts

import * as CommonmarkReactRenderer from "commonmark-react-renderer";
import * as React from "react";

declare namespace md {
    type CommonProps = CommonmarkReactRenderer.CommonProps;
    type HtmlInlineBlockProps = CommonmarkReactRenderer.HtmlInlineBlockProps;
    type CodeBlockProps = CommonmarkReactRenderer.CodeBlockProps;
    type CodeProps = CommonmarkReactRenderer.CodeProps;
    type HeadingProps = CommonmarkReactRenderer.HeadingProps;
    type SoftBreakProps = CommonmarkReactRenderer.SoftBreakProps;
    type LinkProps = CommonmarkReactRenderer.LinkProps;
    type ImageProps = CommonmarkReactRenderer.ImageProps;
    type ListProps = CommonmarkReactRenderer.ListProps;
    type Renderers = CommonmarkReactRenderer.Renderers;

    interface Options {
        renderers?: Partial<Renderers> | undefined;
    }

    type Markings = (...strings: Array<TemplateStringsArray | React.ReactElement>) => React.ReactElement;
    function customize(opts: Options): Markings;
}

declare function md(...strings: Array<TemplateStringsArray | React.ReactElement>): React.ReactElement;

export = md;

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/commonmark-react-renderer, @types/react

Credits

These definitions were written by Nathan Bierema.