Markdown Editor
A React markdown editor with a toolbar that wraps the selection, keyboard shortcuts, write, split and preview modes, a safe live preview without innerHTML and a word count.
src/registry/ui/markdown-editor.tsx/r/markdown-editor.json
Installation#
bash
npx shadcn@latest add @minidev/markdown-editor
MiniDev UI is in the shadcn registry directory, so the short form works with no setup. Older CLI versions can use the full URL: npx shadcn@latest add https://ui.minidev.pro/r/markdown-editor.json
Usage#
tsx
import { MarkdownEditor } from "@/components/ui/markdown-editor"
export function Example() {
return <MarkdownEditor />
}
API reference#
| Prop | Type | Default |
|---|---|---|
value | string | - |
defaultValue | string | SAMPLE |
onChange | (value: string) => void | - |
mode | MarkdownEditorMode | - |
defaultMode | MarkdownEditorMode | "split" |
onModeChange | (mode: MarkdownEditorMode) => void | - |
label | string | "Release notes" |
placeholder | string | "Write in markdown…" |
minHeight | number | 300 |
disabled | boolean | - |
className | string | - |
Dependencies#
npm
lucide-react
Built from
Related forms components#
AutocompleteText input that filters string options as you type, using ARIA combobox and listbox roles. Works controlled or uncontrolled and lists up to eight matches.Calendar MonthMonth calendar grid with weekday headers and clickable day cells that highlight the selected date. A simple Tailwind base for date views and schedulers.Character CountLive React character counter that shows the current count against a limit and turns red when it goes over. Announces changes politely to screen readers.Checkbox GroupVertical wrapper that groups related checkboxes under role group with even spacing. Use it with Checkbox and labels for multi select settings.CheckboxShadcn style checkbox on Base UI with an animated check, indeterminate state, invalid and disabled styles, and an enlarged hit area for touch.Chip FilterSingle select filter chips in React that behave as a radio group, with an accent ring on the active chip. Good for quick filters above lists and tables.
All form components