@powerduck/md-editor 0.11.5 → 0.11.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -9
- package/dist/style.css +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -182,8 +182,8 @@ new MarkdownEditor("#editor", {
|
|
|
182
182
|
| `preview` | `boolean` | `true` | Show preview pane |
|
|
183
183
|
| `autoPreview` | `boolean` | `true` | Auto-update preview |
|
|
184
184
|
| `renderDebounce` | `number` | `200` | Preview render debounce in ms |
|
|
185
|
-
| `mention` | `
|
|
186
|
-
| `docLink` | `
|
|
185
|
+
| `mention` | `MentionOptions` | - | @mention configuration |
|
|
186
|
+
| `docLink` | `DocLinkOptions` | - | Document link card configuration |
|
|
187
187
|
|
|
188
188
|
### Imperative Handle (React)
|
|
189
189
|
|
|
@@ -198,10 +198,10 @@ interface MarkdownEditorHandle {
|
|
|
198
198
|
}
|
|
199
199
|
```
|
|
200
200
|
|
|
201
|
-
###
|
|
201
|
+
### MentionOptions
|
|
202
202
|
|
|
203
203
|
```typescript
|
|
204
|
-
interface
|
|
204
|
+
interface MentionOptions {
|
|
205
205
|
onMentionSearch: (query: string) => MentionItem[] | Promise<MentionItem[]>;
|
|
206
206
|
onMentionSelect?: (item: MentionItem) => string;
|
|
207
207
|
minChars?: number;
|
|
@@ -210,10 +210,10 @@ interface MentionConfig {
|
|
|
210
210
|
}
|
|
211
211
|
```
|
|
212
212
|
|
|
213
|
-
###
|
|
213
|
+
### DocLinkOptions
|
|
214
214
|
|
|
215
215
|
```typescript
|
|
216
|
-
interface
|
|
216
|
+
interface DocLinkOptions {
|
|
217
217
|
onDocSearch: (query: string) => DocItem[] | Promise<DocItem[]>;
|
|
218
218
|
onFetchDocMeta?: (url: string) => Promise<DocMeta>;
|
|
219
219
|
insertStyle?: "card" | "link" | "auto";
|
|
@@ -232,11 +232,13 @@ import type {
|
|
|
232
232
|
MentionItem,
|
|
233
233
|
DocItem,
|
|
234
234
|
DocMeta,
|
|
235
|
-
|
|
236
|
-
|
|
235
|
+
MentionOptions,
|
|
236
|
+
DocLinkOptions,
|
|
237
|
+
} from "@powerduck/md-editor";
|
|
238
|
+
import type {
|
|
237
239
|
MarkdownEditorHandle,
|
|
238
240
|
MarkdownEditorProps,
|
|
239
|
-
} from "@powerduck/md-editor";
|
|
241
|
+
} from "@powerduck/md-editor/react";
|
|
240
242
|
```
|
|
241
243
|
|
|
242
244
|
---
|