कॉन्फ़िगरेशन
MarkdownEditor कंस्ट्रक्टर पहले कंटेनर एलिमेंट या सेलेक्टर और फिर MarkdownEditorOptions ऑब्जेक्ट लेता है। यह पृष्ठ हर फ़ील्ड का टाइप, डिफ़ॉल्ट मान, व्यवहार और संबंधित विकल्पों के टाइप बताता है।
MarkdownEditorOptions
interface MarkdownEditorOptions {
value?: string;
mode?: EditorMode;
theme?: EditorTheme;
math?: boolean;
mindmap?: boolean;
codeHighlight?: boolean;
tips?: boolean;
preview?: boolean;
onChange?: (value: string) => void;
toolbar?: ToolbarConfig;
onImageUpload?: (file: File) => Promise<string>;
mention?: MentionOptions;
docLink?: DocLinkOptions;
renderDebounce?: number | false;
autoPreview?: boolean;
}
| विकल्प | टाइप | डिफ़ॉल्ट | विवरण |
|---|---|---|---|
value | string | '' | शुरुआती Markdown सामग्री। |
mode | EditorMode | 'simple' | 'simple' टूलबार और स्टेटस बार के बिना एडिटर तथा प्रीव्यू दिखाता है। 'complex' दोनों बार जोड़ता है। |
theme | EditorTheme | 'light' | data-theme एट्रिब्यूट से लागू रंग थीम: 'light' या 'dark'। |
math | boolean | true | KaTeX सूत्र सक्षम करें: इनलाइन $...$ और ब्लॉक $$...$$। |
mindmap | boolean | true | ```mindmap फ़ेंस वाले ब्लॉक से Markmap माइंड मैप सक्षम करें। |
codeHighlight | boolean | true | तीन रंगीन बिंदुओं वाले हेडर और कॉपी बटन सहित highlight.js कोड ब्लॉक सक्षम करें। |
tips | boolean | true | :::notice, :::warning जैसे सूचना ब्लॉक सक्षम करें। |
preview | boolean | true | प्रीव्यू पैनल दिखाएँ। false होने पर केवल एडिटर पैनल बनता है। |
onChange | (value: string) => void | — | हर संपादन पर पूरे दस्तावेज़ की स्ट्रिंग के साथ कॉल होता है। |
toolbar | ToolbarConfig | सभी क्रियाएँ | टूलबार में दिखने वाली क्रियाएँ चुनें और उनके लेब ल या आइकन बदलें। |
onImageUpload | (file: File) => Promise<string> | — | एडिटर में इमेज फ़ाइल पेस्ट या ड्रैग-ड्रॉप होने पर कॉल होने वाला हुक। Promise को इमेज URL लौटाना चाहिए, जिसे  के रूप में डाला जाता है। इमेज डायलॉग URL लेता है; इसमें फ़ाइल चुनने की सुविधा नहीं है। |
mention | MentionOptions | — | @मेंशन ड्रॉपडाउन का कॉन्फ़िगरेशन। न देने पर @ टाइप करने से ड्रॉपडाउन नहीं खुलता। |
docLink | DocLinkOptions | — | दस्तावेज़ लिंक डालने का कॉन्फ़िगरेशन। न देने पर ट्रिगर वर्ण टाइप करने से ड्रॉपडाउन नहीं खुलता। |
renderDebounce | number | false | अनुकूली | प्रीव्यू डिबाउंस का विलंब, मिलीसेकंड में। false हर संपादन पर सिंक्रोनस रेंडर करता है; संख्या निश्चित विलंब तय करती है। न देने पर adaptiveDebounceMs(value.length) इस्तेमाल होता है, 120 से अधिकतम 600 मिलीसेकंड तक। |
autoPreview | boolean | true | true होने पर संपादन के बाद प्रीव्यू डिबाउंस के साथ दोबारा रेंडर होता है। false होने पर renderNow() कॉल करें या स्टेटस बार का रिफ़्रेश बटन इस्तेमाल करें। |
EditorMode और EditorTheme
type EditorMode = 'simple' | 'complex';
type EditorTheme = 'light' | 'dark';
'simple'(डिफ़ॉल्ट): टूलबार, स्टेटस बार और लाइन नंबर नहीं दिखते।'complex': टूलबार, स्टेटस बार और लाइन नंबर सक्षम होते हैं।'light'(डिफ़ॉल्ट) और'dark'सिंटैक्स हाइलाइट के रंग तथा CSS कस्टम प्रॉपर्टी नियंत्रित करते हैं।
दोनों को रनटाइम पर setMode(mode) और setTheme(theme) से बदला जा सकता है।
ToolbarConfig
ToolbarConfig या तो दिखाने वाली क्रियाओं के नामों की ऐरे है, या क्रिया के नाम को उसकी कस्टम सेटिंग से जोड़ने वाला ऑब्जेक्ट:
type ToolbarConfig = string[] | Record<string, ToolbarItemOverride>;