Markdown

This field lets you display markdown content. It supports GitHub Flavored Markdown.

Usage

Let's see how we can use <MarkdownField> in a show page.

http://localhost:3000/posts/show/123

import { useShow } from "@pankod/refine-core";
import {
    Show,
    Heading,
    Text,
    MarkdownField,
} from "@pankod/refine-chakra-ui";

const PostShow: React.FC = () => {
    const { queryResult } = useShow<IPost>();
    const { data, isLoading } = queryResult;
    const record = data?.data;

    return (
        <Show isLoading={isLoading}>
            <Heading as="h5" size="sm">
                Id
            </Heading>
            <Text mt={2}>{record?.id}</Text>

            <Heading as="h5" size="sm" mt={4}>
                Content
            </Heading>
            <MarkdownField value={record?.content} />
        </Show>
    );
};

interface IPost {
    id: number;
    content: string;
}

API Reference

Properties