A simple markdown editor with preview, implemented with Next.js and TypeScript.
Installations
npm install next-md-editor
Developer Guide
Typescript
Yes
Module System
CommonJS
Node Version
16.18.0
NPM Version
8.19.2
Score
66.2
Supply Chain
94
Quality
74.2
Maintenance
100
Vulnerability
100
License
Releases
Contributors
Unable to fetch Contributors
Languages
TypeScript (91.95%)
Less (6.59%)
HTML (1.42%)
Shell (0.05%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
Download Statistics
Total Downloads
1,338
Last Day
1
Last Week
5
Last Month
20
Last Year
827
GitHub Statistics
MIT License
5 Stars
732 Commits
1 Branches
1 Contributors
Updated on Dec 03, 2024
Package Meta Information
Latest Version
1.0.0
Package Id
next-md-editor@1.0.0
Unpacked Size
741.78 kB
Size
133.70 kB
File Count
272
NPM Version
8.19.2
Node Version
16.18.0
Total Downloads
Cumulative downloads
Total Downloads
1,338
Last Day
-50%
1
Compared to previous day
Last Week
-44.4%
5
Compared to previous week
Last Month
122.2%
20
Compared to previous month
Last Year
147.6%
827
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
A simple markdown editor with preview, implemented with React.js and TypeScript. This React Component aims to provide a simple Markdown editor with syntax highlighting support. This is based on textarea
encapsulation, so it does not depend on any modern code editors such as Acs, CodeMirror, Monaco etc.
Features
- 📑 Indent line or selected text by pressing tab key, with customizable indentation.
- ♻️ Based on
textarea
encapsulation, does not depend on any modern code editors. - 🚧 Does not depend on the
uiw
component library. - 🚘 Automatic list on new lines.
- 😻 GitHub flavored markdown support.
- 🌒 Support dark-mode/night-mode @v3.11.0+.
- 💡 Support next.js, Use examples in next.js.
Quick Start
1npm i @uiw/react-md-editor
Using
1import React from "react"; 2import MDEditor from '@uiw/react-md-editor'; 3 4export default function App() { 5 const [value, setValue] = React.useState("**Hello world!!!**"); 6 return ( 7 <div className="container"> 8 <MDEditor 9 value={value} 10 onChange={setValue} 11 /> 12 <MDEditor.Markdown source={value} style={{ whiteSpace: 'pre-wrap' }} /> 13 </div> 14 ); 15}
Special Markdown syntax
Supports for CSS Style
Use HTML comments <!--rehype:xxx-->
to let Markdown support style customization.
1## Title 2<!--rehype:style=display: flex; height: 230px; align-items: center; justify-content: center; font-size: 38px;--> 3 4Markdown Supports **Style**<!--rehype:style=color: red;-->
Ignore content display via HTML comments
Shown in GitHub readme, excluded in HTML.
1# Hello World 2 3<!--rehype:ignore:start-->Hello World<!--rehype:ignore:end--> 4 5Good!
Output:
1<h1>Hello World</h1> 2 3<p>Good!</p>
Security
Please note markdown needs to be sanitized if you do not completely trust your authors. Otherwise, your app is vulnerable to XSS. This can be achieved by adding rehype-sanitize as a plugin.
1import React from "react"; 2import MDEditor from '@uiw/react-md-editor'; 3import rehypeSanitize from "rehype-sanitize"; 4 5export default function App() { 6 const [value, setValue] = React.useState(`**Hello world!!!** <IFRAME SRC=\"javascript:javascript:alert(window.origin);\"></IFRAME>`); 7 return ( 8 <div className="container"> 9 <MDEditor 10 value={value} 11 onChange={setValue} 12 previewOptions={{ 13 rehypePlugins: [[rehypeSanitize]], 14 }} 15 /> 16 </div> 17 ); 18}
Custom Toolbars
1import React from "react"; 2import MDEditor, { commands } from '@uiw/react-md-editor'; 3 4const title3 = { 5 name: 'title3', 6 keyCommand: 'title3', 7 buttonProps: { 'aria-label': 'Insert title3' }, 8 icon: ( 9 <svg width="12" height="12" viewBox="0 0 520 520"> 10 <path fill="currentColor" d="M15.7083333,468 C7.03242448,468 0,462.030833 0,454.666667 L0,421.333333 C0,413.969167 7.03242448,408 15.7083333,408 L361.291667,408 C369.967576,408 377,413.969167 377,421.333333 L377,454.666667 C377,462.030833 369.967576,468 361.291667,468 L15.7083333,468 Z M21.6666667,366 C9.69989583,366 0,359.831861 0,352.222222 L0,317.777778 C0,310.168139 9.69989583,304 21.6666667,304 L498.333333,304 C510.300104,304 520,310.168139 520,317.777778 L520,352.222222 C520,359.831861 510.300104,366 498.333333,366 L21.6666667,366 Z M136.835938,64 L136.835937,126 L107.25,126 L107.25,251 L40.75,251 L40.75,126 L-5.68434189e-14,126 L-5.68434189e-14,64 L136.835938,64 Z M212,64 L212,251 L161.648438,251 L161.648438,64 L212,64 Z M378,64 L378,126 L343.25,126 L343.25,251 L281.75,251 L281.75,126 L238,126 L238,64 L378,64 Z M449.047619,189.550781 L520,189.550781 L520,251 L405,251 L405,64 L449.047619,64 L449.047619,189.550781 Z" /> 11 </svg> 12 ), 13 execute: (state, api) => { 14 let modifyText = `### ${state.selectedText}\n`; 15 if (!state.selectedText) { 16 modifyText = `### `; 17 } 18 api.replaceSelection(modifyText); 19 }, 20}; 21 22const title2 = { 23 name: 'title2', 24 keyCommand: 'title2', 25 render: (command, disabled, executeCommand) => { 26 return ( 27 <button 28 aria-label="Insert title2" 29 disabled={disabled} 30 onClick={(evn) => { 31 // evn.stopPropagation(); 32 executeCommand(command, command.groupName) 33 }} 34 > 35 <svg width="12" height="12" viewBox="0 0 520 520"> 36 <path fill="currentColor" d="M15.7083333,468 C7.03242448,468 0,462.030833 0,454.666667 L0,421.333333 C0,413.969167 7.03242448,408 15.7083333,408 L361.291667,408 C369.967576,408 377,413.969167 377,421.333333 L377,454.666667 C377,462.030833 369.967576,468 361.291667,468 L15.7083333,468 Z M21.6666667,366 C9.69989583,366 0,359.831861 0,352.222222 L0,317.777778 C0,310.168139 9.69989583,304 21.6666667,304 L498.333333,304 C510.300104,304 520,310.168139 520,317.777778 L520,352.222222 C520,359.831861 510.300104,366 498.333333,366 L21.6666667,366 Z M136.835938,64 L136.835937,126 L107.25,126 L107.25,251 L40.75,251 L40.75,126 L-5.68434189e-14,126 L-5.68434189e-14,64 L136.835938,64 Z M212,64 L212,251 L161.648438,251 L161.648438,64 L212,64 Z M378,64 L378,126 L343.25,126 L343.25,251 L281.75,251 L281.75,126 L238,126 L238,64 L378,64 Z M449.047619,189.550781 L520,189.550781 L520,251 L405,251 L405,64 L449.047619,64 L449.047619,189.550781 Z" /> 37 </svg> 38 </button> 39 ) 40 }, 41 execute: (state, api) => { 42 let modifyText = `## ${state.selectedText}\n`; 43 if (!state.selectedText) { 44 modifyText = `## `; 45 } 46 api.replaceSelection(modifyText); 47 }, 48} 49 50export default function App() { 51 const [value, setValue] = React.useState("Hello Markdown! `Tab` key uses default behavior"); 52 return ( 53 <div className="container"> 54 <MDEditor 55 value={value} 56 onChange={setValue} 57 commands={[ 58 // Custom Toolbars 59 title3, title2, 60 commands.group([commands.title1, commands.title2, commands.title3, commands.title4, commands.title5, commands.title6], { 61 name: 'title', 62 groupName: 'title', 63 buttonProps: { 'aria-label': 'Insert title'} 64 }), 65 commands.divider, 66 commands.group([], { 67 name: 'update', 68 groupName: 'update', 69 icon: ( 70 <svg viewBox="0 0 1024 1024" width="12" height="12"> 71 <path fill="currentColor" d="M716.8 921.6a51.2 51.2 0 1 1 0 102.4H307.2a51.2 51.2 0 1 1 0-102.4h409.6zM475.8016 382.1568a51.2 51.2 0 0 1 72.3968 0l144.8448 144.8448a51.2 51.2 0 0 1-72.448 72.3968L563.2 541.952V768a51.2 51.2 0 0 1-45.2096 50.8416L512 819.2a51.2 51.2 0 0 1-51.2-51.2v-226.048l-57.3952 57.4464a51.2 51.2 0 0 1-67.584 4.2496l-4.864-4.2496a51.2 51.2 0 0 1 0-72.3968zM512 0c138.6496 0 253.4912 102.144 277.1456 236.288l10.752 0.3072C924.928 242.688 1024 348.0576 1024 476.5696 1024 608.9728 918.8352 716.8 788.48 716.8a51.2 51.2 0 1 1 0-102.4l8.3968-0.256C866.2016 609.6384 921.6 550.0416 921.6 476.5696c0-76.4416-59.904-137.8816-133.12-137.8816h-97.28v-51.2C691.2 184.9856 610.6624 102.4 512 102.4S332.8 184.9856 332.8 287.488v51.2H235.52c-73.216 0-133.12 61.44-133.12 137.8816C102.4 552.96 162.304 614.4 235.52 614.4l5.9904 0.3584A51.2 51.2 0 0 1 235.52 716.8C105.1648 716.8 0 608.9728 0 476.5696c0-132.1984 104.8064-239.872 234.8544-240.2816C258.5088 102.144 373.3504 0 512 0z" /> 72 </svg> 73 ), 74 children: ({ close, execute, getState, textApi }) => { 75 return ( 76 <div style={{ width: 120, padding: 10 }}> 77 <div>My Custom Toolbar</div> 78 <button type="button" onClick={() => console.log('> execute: >>>>>', getState())}>State</button> 79 <button type="button" onClick={() => close()}>Close</button> 80 <button type="button" onClick={() => execute()}>Execute</button> 81 </div> 82 ); 83 }, 84 execute: (state, api) => { 85 console.log('>>>>>>update>>>>>', state) 86 }, 87 buttonProps: { 'aria-label': 'Insert title'} 88 }), 89 ]} 90 /> 91 </div> 92 ); 93}
Customize the toolbar with commands
and extraCommands
props.
1import React from "react"; 2import MDEditor, { commands } from '@uiw/react-md-editor'; 3 4export default function App() { 5 const [value, setValue] = React.useState("Hello Markdown! `Tab` key uses default behavior"); 6 return ( 7 <div className="container"> 8 <MDEditor 9 value={value} 10 onChange={setValue} 11 preview="edit" 12 commands={[ 13 commands.codeEdit, commands.codePreview 14 ]} 15 extraCommands={[ 16 commands.group([commands.title1, commands.title2, commands.title3, commands.title4, commands.title5, commands.title6], { 17 name: 'title', 18 groupName: 'title', 19 buttonProps: { 'aria-label': 'Insert title'} 20 }), 21 commands.divider, 22 commands.group([], { 23 name: 'update', 24 groupName: 'update', 25 icon: ( 26 <svg viewBox="0 0 1024 1024" width="12" height="12"> 27 <path fill="currentColor" d="M716.8 921.6a51.2 51.2 0 1 1 0 102.4H307.2a51.2 51.2 0 1 1 0-102.4h409.6zM475.8016 382.1568a51.2 51.2 0 0 1 72.3968 0l144.8448 144.8448a51.2 51.2 0 0 1-72.448 72.3968L563.2 541.952V768a51.2 51.2 0 0 1-45.2096 50.8416L512 819.2a51.2 51.2 0 0 1-51.2-51.2v-226.048l-57.3952 57.4464a51.2 51.2 0 0 1-67.584 4.2496l-4.864-4.2496a51.2 51.2 0 0 1 0-72.3968zM512 0c138.6496 0 253.4912 102.144 277.1456 236.288l10.752 0.3072C924.928 242.688 1024 348.0576 1024 476.5696 1024 608.9728 918.8352 716.8 788.48 716.8a51.2 51.2 0 1 1 0-102.4l8.3968-0.256C866.2016 609.6384 921.6 550.0416 921.6 476.5696c0-76.4416-59.904-137.8816-133.12-137.8816h-97.28v-51.2C691.2 184.9856 610.6624 102.4 512 102.4S332.8 184.9856 332.8 287.488v51.2H235.52c-73.216 0-133.12 61.44-133.12 137.8816C102.4 552.96 162.304 614.4 235.52 614.4l5.9904 0.3584A51.2 51.2 0 0 1 235.52 716.8C105.1648 716.8 0 608.9728 0 476.5696c0-132.1984 104.8064-239.872 234.8544-240.2816C258.5088 102.144 373.3504 0 512 0z" /> 28 </svg> 29 ), 30 children: ({ close, execute, getState, textApi }) => { 31 return ( 32 <div style={{ width: 120, padding: 10 }}> 33 <div>My Custom Toolbar</div> 34 <button type="button" onClick={() => console.log('> execute: >>>>>', getState())}>State</button> 35 <button type="button" onClick={() => close()}>Close</button> 36 <button type="button" onClick={() => execute()}>Execute</button> 37 </div> 38 ); 39 }, 40 execute: (state, api) => { 41 console.log('>>>>>>update>>>>>', state) 42 }, 43 buttonProps: { 'aria-label': 'Insert title'} 44 }), 45 commands.divider, commands.fullscreen 46 ]} 47 /> 48 </div> 49 ); 50}
re-render toolbar
element.
1import React from "react"; 2import MDEditor, { commands } from '@uiw/react-md-editor'; 3 4export default function App() { 5 const [value, setValue] = React.useState("Hello Markdown! `Tab` key uses default behavior"); 6 return ( 7 <div className="container"> 8 <MDEditor 9 value={value} 10 onChange={setValue} 11 preview="edit" 12 components={{ 13 toolbar: (command, disabled, executeCommand) => { 14 if (command.keyCommand === 'code') { 15 return ( 16 <button 17 aria-label="Insert code" 18 disabled={disabled} 19 onClick={(evn) => { 20 evn.stopPropagation(); 21 executeCommand(command, command.groupName) 22 }} 23 > 24 Code 25 </button> 26 ) 27 } 28 } 29 }} 30 /> 31 </div> 32 ); 33}
Custom Preview Command Tool
1import React, { useContext } from "react"; 2import MDEditor, { commands, EditorContext } from "@uiw/react-md-editor"; 3 4const Button = () => { 5 const { preview, dispatch } = useContext(EditorContext); 6 const click = () => { 7 dispatch({ 8 preview: preview === "edit" ? "preview" : "edit" 9 }); 10 }; 11 if (preview === "edit") { 12 return ( 13 <svg width="12" height="12" viewBox="0 0 520 520" onClick={click}> 14 <polygon 15 fill="currentColor" 16 points="0 71.293 0 122 319 122 319 397 0 397 0 449.707 372 449.413 372 71.293" 17 /> 18 <polygon 19 fill="currentColor" 20 points="429 71.293 520 71.293 520 122 481 123 481 396 520 396 520 449.707 429 449.413" 21 /> 22 </svg> 23 ); 24 } 25 return ( 26 <svg width="12" height="12" viewBox="0 0 520 520" onClick={click}> 27 <polygon 28 fill="currentColor" 29 points="0 71.293 0 122 38.023 123 38.023 398 0 397 0 449.707 91.023 450.413 91.023 72.293" 30 /> 31 <polygon 32 fill="currentColor" 33 points="148.023 72.293 520 71.293 520 122 200.023 124 200.023 397 520 396 520 449.707 148.023 450.413" 34 /> 35 </svg> 36 ); 37}; 38 39const codePreview = { 40 name: "preview", 41 keyCommand: "preview", 42 value: "preview", 43 icon: <Button /> 44}; 45 46export default function App() { 47 const [value, setValue] = React.useState("**Hello world!!!**"); 48 return ( 49 <div className="container"> 50 <div>The system automatically sets the theme</div> 51 <MDEditor 52 value={value} 53 preview="edit" 54 extraCommands={[codePreview, commands.fullscreen]} 55 onChange={(val) => setValue(val)} 56 /> 57 </div> 58 ); 59}
Editor Font Size
1.w-md-editor-text-pre > code, 2.w-md-editor-text-input { 3 font-size: 23px !important; 4 line-height: 24px !important; 5}
Preview Markdown
1import React from "react"; 2import ReactDOM from "react-dom"; 3import MDEditor from '@uiw/react-md-editor'; 4 5export default function App() { 6 return ( 7 <div className="container"> 8 <MDEditor.Markdown source="Hello Markdown!" /> 9 </div> 10 ); 11}
Support Custom KaTeX Preview
KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web, We perform math rendering through KaTeX
.
The following example is preview in CodeSandbox.
⚠️ Upgrade v2 to v3 d025430
1npm install katex
1import React from "react"; 2import ReactDOM from "react-dom"; 3import MDEditor from '@uiw/react-md-editor'; 4import { getCodeString } from 'rehype-rewrite'; 5import katex from 'katex'; 6import 'katex/dist/katex.css'; 7 8const mdKaTeX = `This is to display the 9\`\$\$\c = \\pm\\sqrt{a^2 + b^2}\$\$\` 10 in one line 11 12\`\`\`KaTeX 13c = \\pm\\sqrt{a^2 + b^2} 14\`\`\` 15`; 16 17export default function App() { 18 return ( 19 <MDEditor 20 value={mdKaTeX} 21 previewOptions={{ 22 components: { 23 code: ({ inline, children = [], className, ...props }) => { 24 const txt = children[0] || ''; 25 if (inline) { 26 if (typeof txt === 'string' && /^\$\$(.*)\$\$/.test(txt)) { 27 const html = katex.renderToString(txt.replace(/^\$\$(.*)\$\$/, '$1'), { 28 throwOnError: false, 29 }); 30 return <code dangerouslySetInnerHTML={{ __html: html }} />; 31 } 32 return <code>{txt}</code>; 33 } 34 const code = props.node && props.node.children ? getCodeString(props.node.children) : txt; 35 if ( 36 typeof code === 'string' && 37 typeof className === 'string' && 38 /^language-katex/.test(className.toLocaleLowerCase()) 39 ) { 40 const html = katex.renderToString(code, { 41 throwOnError: false, 42 }); 43 return <code style={{ fontSize: '150%' }} dangerouslySetInnerHTML={{ __html: html }} />; 44 } 45 return <code className={String(className)}>{txt}</code>; 46 }, 47 }, 48 }} 49 /> 50 ); 51}
Markdown text to Image
1import React, { useState } from "react"; 2import MDEditor, { commands, ICommand, TextState, TextAreaTextApi } from "@uiw/react-md-editor"; 3import domToImage from "dom-to-image"; 4 5const textToImage: ICommand = { 6 name: "Text To Image", 7 keyCommand: "text2image", 8 buttonProps: { "aria-label": "Insert title3" }, 9 icon: ( 10 <svg width="12" height="12" viewBox="0 0 20 20"> 11 <path fill="currentColor" d="M15 9c1.1 0 2-.9 2-2s-.9-2-2-2-2 .9-2 2 .9 2 2 2zm4-7H1c-.55 0-1 .45-1 1v14c0 .55.45 1 1 1h18c.55 0 1-.45 1-1V3c0-.55-.45-1-1-1zm-1 13l-6-5-2 2-4-5-4 8V4h16v11z" ></path> 12 </svg> 13 ), 14 execute: (state: TextState, api: TextAreaTextApi) => { 15 const dom = document.getElementsByClassName("gooooooooo")[0]; 16 if (dom) { 17 domToImage.toJpeg(dom, {}).then((dataUrl) => { 18 const link = document.createElement("a"); 19 link.download = "image.jpg"; 20 link.href = dataUrl; 21 link.click(); 22 }); 23 } 24 } 25}; 26 27export default function App() { 28 const [value, setValue] = useState('**Hello world!!!**'); 29 console.log('value::', value) 30 return ( 31 <div className="container"> 32 <MDEditor 33 className="gooooooooo" 34 onChange={(newValue = "") => setValue(newValue)} 35 value={value} 36 commands={[ 37 textToImage, 38 commands.divider 39 ]} 40 /> 41 </div> 42 ); 43}
Support Custom Mermaid Preview
Using mermaid to generation of diagram and flowchart from text in a similar manner as markdown
1npm install mermaid
1import React, { useState, useRef, useEffect } from "react"; 2import ReactDOM from "react-dom"; 3import MDEditor from "@uiw/react-md-editor"; 4import mermaid from "mermaid"; 5 6const mdMermaid = `The following are some examples of the diagrams, charts and graphs that can be made using Mermaid and the Markdown-inspired text specific to it. 7 8\`\`\`mermaid 9graph TD 10A[Hard] -->|Text| B(Round) 11B --> C{Decision} 12C -->|One| D[Result 1] 13C -->|Two| E[Result 2] 14\`\`\` 15 16\`\`\`mermaid 17sequenceDiagram 18Alice->>John: Hello John, how are you? 19loop Healthcheck 20 John->>John: Fight against hypochondria 21end 22Note right of John: Rational thoughts! 23John-->>Alice: Great! 24John->>Bob: How about you? 25Bob-->>John: Jolly good! 26\`\`\` 27`; 28 29const randomid = () => parseInt(String(Math.random() * 1e15), 10).toString(36); 30const Code = ({ inline, children = [], className, ...props }) => { 31 const demoid = useRef(`dome${randomid()}`); 32 const code = getCode(children); 33 const demo = useRef(null); 34 useEffect(() => { 35 if (demo.current) { 36 try { 37 const str = mermaid.render(demoid.current, code, () => null, demo.current); 38 // @ts-ignore 39 demo.current.innerHTML = str; 40 } catch (error) { 41 // @ts-ignore 42 demo.current.innerHTML = error; 43 } 44 } 45 }, [code, demo]); 46 47 if ( 48 typeof code === "string" && typeof className === "string" && 49 /^language-mermaid/.test(className.toLocaleLowerCase()) 50 ) { 51 return ( 52 <code ref={demo}> 53 <code id={demoid.current} style={{ display: "none" }} /> 54 </code> 55 ); 56 } 57 return <code className={String(className)}>{children}</code>; 58}; 59 60const getCode = (arr = []) => arr.map((dt) => { 61 if (typeof dt === "string") { 62 return dt; 63 } 64 if (dt.props && dt.props.children) { 65 return getCode(dt.props.children); 66 } 67 return false; 68}).filter(Boolean).join(""); 69 70export default function App() { 71 const [value, setValue] = useState(mdMermaid); 72 return ( 73 <MDEditor 74 onChange={(newValue = "") => setValue(newValue)} 75 textareaProps={{ 76 placeholder: "Please enter Markdown text" 77 }} 78 height={500} 79 value={value} 80 previewOptions={{ 81 components: { 82 code: Code 83 } 84 }} 85 /> 86 ); 87}
Support Nextjs
Use examples in nextjs. #52
#224
1npm install next-remove-imports 2npm install @uiw/react-md-editor@v3.6.0
1// next.config.js 2const removeImports = require('next-remove-imports')(); 3module.exports = removeImports({});
1import "@uiw/react-md-editor/markdown-editor.css"; 2import "@uiw/react-markdown-preview/markdown.css"; 3import dynamic from "next/dynamic"; 4import { useState } from "react"; 5 6const MDEditor = dynamic( 7 () => import("@uiw/react-md-editor"), 8 { ssr: false } 9); 10 11function HomePage() { 12 const [value, setValue] = useState("**Hello world!!!**"); 13 return ( 14 <div> 15 <MDEditor value={value} onChange={setValue} /> 16 </div> 17 ); 18} 19 20export default HomePage;
Support dark-mode/night-mode
By default, the dark-mode
is automatically switched according to the system. If you need to switch manually, just set the data-color-mode="dark"
parameter for body.
1<html data-color-mode="dark">
1document.documentElement.setAttribute('data-color-mode', 'dark')
2document.documentElement.setAttribute('data-color-mode', 'light')
Inherit custom color variables by adding .wmde-markdown-var
selector. Setting theme styles with data-color-mode="light"
.
1<div data-color-mode="light"> 2 <div className="wmde-markdown-var"> </div> 3 <MDEditor source="Hello World!" /> 4</div>
Props
value: string
: The Markdown value.onChange?: (value?: string, event?: React.ChangeEvent<HTMLTextAreaElement>, state?: ContextStore)
: Event handler for theonChange
event.onHeightChange?: ((value?: CSSProperties['height'], oldValue?: CSSProperties['height'], state?: ContextStore)
: editor height change listener.commands?: ICommand[]
: An array ofICommand
, which, each one, contain acommands
property. If no commands are specified, the default will be used. Commands are explained in more details below.commandsFilter?: (command: ICommand, isExtra: boolean) => false | ICommand
: Filter or modify your commands.extraCommands?: ICommand[]
: Displayed on the right side of the toolbar.autoFocus?: true
: Can be used to makeMarkdown Editor
focus itself on initialization.previewOptions?: ReactMarkdown.ReactMarkdownProps
: This is reset @uiw/react-markdown-preview settings.textareaProps?: TextareaHTMLAttributes
: Set thetextarea
related props.:renderTextarea?: (props, opts) => JSX.Element;
@deprecated
Please use->renderTextarea
components
. Use div to replace TextArea or re-render TextArea. #193components
: re-render textarea/toolbar element. #419textarea
Use div to replace TextArea or re-render TextAreatoolbar
Override the default command element.toolbar
<command[].render
preview
Custom markdown preview. #429
height?: number=200
: The height of the editor. ️⚠️Dragbar
is invalid whenheight
parameter percentage.visibleDragbar?: boolean=true
: Show drag and drop tool. Set the height of the editor.highlightEnable?: boolean=true
: Disable editing area code highlighting. The value isfalse
, which increases the editing speed.fullscreen?: boolean=false
: Show markdown preview.overflow?: boolean=true
: Disablefullscreen
setting body stylespreview?: 'live' | 'edit' | 'preview'
: Default valuelive
, Show markdown preview.maxHeight?: number=1200
: Maximum drag height. ThevisibleDragbar=true
value is valid.minHeights?: number=100
: Minimum drag height. ThevisibleDragbar=true
value is valid.tabSize?: number=2
: The number of characters to insert when pressing tab key. Default2
spaces.defaultTabEnable?: boolean=false
: Iffalse
, thetab
key inserts a tab character into the textarea. Iftrue
, thetab
key executes default behavior e.g. focus shifts to next element.hideToolbar?: boolean=false
: Option to hide the tool bar.enableScroll?: boolean=true
: Whether to enable scrolling.
Development
1npm run watch # Listen create type and .tsx files. 2npm run css:watch # listen to the component compile and output the .css file 3npm run start # Preview code example.
Related
- @uiw/react-textarea-code-editor: A simple code editor with syntax highlighting.
- @uiw/react-md-editor: A simple markdown editor with preview, implemented with React.js and TypeScript.
- @uiw/react-codemirror: CodeMirror component for React. @codemirror
- @uiw/react-monacoeditor: Monaco Editor component for React.
- @uiw/react-markdown-editor: A markdown editor with preview, implemented with React.js and TypeScript.
- @uiw/react-markdown-preview: React component preview markdown text in web browser.
Contributors
As always, thanks to our amazing contributors!
Made with github-action-contributors.
License
Licensed under the MIT License.

No vulnerabilities found.

No security vulnerabilities found.