aq-uicountWords
functionSource L33Public function export from Use Markdown Editor.
function countWords(value: string)Parameters
| Name | Type |
|---|---|
value | string |
Use Markdown Editor
Open-code aq-ui React hook for Use Markdown Editor.
Installation
pnpm dlx aq-ui@alpha add use-markdown-editorAPI reference
Client moduleImport the parts you need, then jump to an export for its contract.
Quick start
"use client"
import { useMarkdownEditor } from "@/hooks/use-markdown-editor"
const result = useMarkdownEditor()MarkdownCommand
typeSource L9Type contract for MarkdownCommand.
type MarkdownCommand = "bold" | "italic" | "strike" | "heading" | "bullet-list" | "ordered-list" | "task-list" | "quote" | "link" | "image" | "table" | "code"MarkdownEditorMode
typeSource L7Type contract for MarkdownEditorMode.
type MarkdownEditorMode = "write" | "preview" | "split"useMarkdownEditor
functionSource L38Open-code aq-ui React hook for Use Markdown Editor.
function useMarkdownEditor({ value, defaultValue = "", onChange, mode, defaultMode = "write", onModeChange, maxLength, }: UseMarkdownEditorOptions = {})Parameters
| Name | Type | Default |
|---|---|---|
options? | UseMarkdownEditorOptions | {} |
const result = useMarkdownEditor()
UseMarkdownEditorOptions
interfaceSource L23Type contract for UseMarkdownEditorOptions.
interface UseMarkdownEditorOptionsMembers
| Name | Type | Default |
|---|---|---|
value? | string | — |
defaultValue? | string | "" |
onChange? | (value: string) => void | — |
mode? | MarkdownEditorMode | — |
defaultMode? | MarkdownEditorMode | "write" |
onModeChange? | (mode: MarkdownEditorMode) => void | — |
maxLength? | number | — |
Registry dependencies
use-code-editor
Files
- hooks/use-markdown-editor.ts