@kaitify/react 0.0.1-beta.1

package/docs/menus/built-in/align-justify.md

@@ -0,0 +1,29 @@
+---
+title: align-justify 两端对齐
+---
+
+# align-justify 两端对齐
+
+设置/取消块节点的两端对齐效果
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, AlignJustifyMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<AlignJustifyMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### shortcut <Badge type="danger" text="(e: KeyboardEvent) => boolean" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/align-left.md

@@ -0,0 +1,29 @@
+---
+title: align-left 左对齐
+---
+
+# align-left 左对齐
+
+设置/取消块节点的左对齐效果
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, AlignLeftMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<AlignLeftMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### shortcut <Badge type="danger" text="(e: KeyboardEvent) => boolean" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/align-right.md

@@ -0,0 +1,29 @@
+---
+title: align-right 右对齐
+---
+
+# align-right 右对齐
+
+设置/取消块节点的右对齐效果
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, AlignRightMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<AlignRightMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### shortcut <Badge type="danger" text="(e: KeyboardEvent) => boolean" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/attachment.md

@@ -0,0 +1,41 @@
+---
+title: attacment 附件
+---
+
+# attacment 附件
+
+插入附件 / 更新附件
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, AttachmentMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<AttachmentMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### tabs <Badge type="danger" text="{ data: ('remote' | 'upload')[]; default: 'remote' | 'upload'}" />
+
+配置浮层内的选项卡，目前支持 `upload`（本地上传）和 `remote`（远程附件），`data` 表示选项卡的数据，`default` 表示默认展示的选项卡
+
+##### popoverProps <Badge type="danger" text="Omit<NonNullable<MenuPropsType['popoverProps']>, 'onShow' | 'onShowing' | 'onShown' | 'onHide' | 'onHiding' | 'onHidden'>" />
+
+浮层属性配置，参考 `Menu` 的 `popoverProps` 属性
+
+##### iconUrl <Badge type="danger" text="string" />
+
+全局设置的附件的 logo 图标地址
+
+##### customUpload <Badge type="danger" text="(file: File) => string | Promise<string>" />
+
+自定义本地附件上传的方法，该方法返回一个字符串值，表示上传后的附件文件地址，回调参数为 `File` 文件，如果不设置该方法，附件默认以 `base64` 字符串的形式插入编辑器中

package/docs/menus/built-in/back-color.md

@@ -0,0 +1,33 @@
+---
+title: back-color 文本背景色
+---
+
+# back-color 文本背景色
+
+设置/取消文本的背景色
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, BackColorMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<BackColorMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### colors <Badge type="danger" text="string[]" />
+
+自定义背景色的可选择颜色数组
+
+##### popoverProps <Badge type="danger" text="Omit<NonNullable<MenuPropsType['popoverProps']>, 'onShow' | 'onShowing' | 'onShown' | 'onHide' | 'onHiding' | 'onHidden'>" />
+
+浮层属性配置，参考 `Menu` 的 `popoverProps` 属性

package/docs/menus/built-in/blockquote.md

@@ -0,0 +1,29 @@
+---
+title: blockquote 引用
+---
+
+# blockquote 引用
+
+设置/取消引用
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, BlockquoteMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<BlockquoteMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### shortcut <Badge type="danger" text="(e: KeyboardEvent) => boolean" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/bold.md

@@ -0,0 +1,29 @@
+---
+title: bold 加粗
+---
+
+# bold 加粗
+
+设置/取消文本加粗效果
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, BoldMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<BoldMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### shortcut <Badge type="danger" text="(e: KeyboardEvent) => boolean" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/clear-format.md

@@ -0,0 +1,29 @@
+---
+title: clear-format 清除格式
+---
+
+# clear-format 清除格式
+
+清除文本的所有样式和标记
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, ClearFormatMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<ClearFormatMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### shortcut <Badge type="danger" text="(e: KeyboardEvent) => boolean" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/code-block-languages.md

@@ -0,0 +1,37 @@
+---
+title: code-block-languages 代码块语言选择
+---
+
+# code-block-languages 代码块语言选择
+
+选择语言来设置代码块的高亮
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, CodeBlockLanguagesMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<CodeBlockLanguagesMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### languages <Badge type="danger" text="HljsLanguageType[]" />
+
+自定义可选择的语言列表，默认是全量的值，全量值请参考 `HljsLanguages` 的值
+
+##### popoverProps <Badge type="danger" text="Omit<NonNullable<MenuPropsType['popoverProps']>, 'onShow' | 'onShowing' | 'onShown' | 'onHide' | 'onHiding' | 'onHidden'>" />
+
+浮层属性配置，参考 `Menu` 的 `popoverProps` 属性
+
+##### shortcut <Badge type="danger" text="{ [key: MenuDataType['value']]: (e: KeyboardEvent) => boolean }" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/code-block.md

@@ -0,0 +1,29 @@
+---
+title: code-block 代码块
+---
+
+# code-block 代码块
+
+设置/取消代码块
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, CodeBlockMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<CodeBlockMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### shortcut <Badge type="danger" text="(e: KeyboardEvent) => boolean" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/code.md

@@ -0,0 +1,29 @@
+---
+title: code 行内代码
+---
+
+# code 行内代码
+
+设置/取消行内代码
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, CodeMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<CodeMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### shortcut <Badge type="danger" text="(e: KeyboardEvent) => boolean" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/color.md

@@ -0,0 +1,33 @@
+---
+title: color 文本字体颜色
+---
+
+# color 文本字体颜色
+
+设置/取消文本的字体颜色
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, ColorMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<ColorMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### colors <Badge type="danger" text="string[]" />
+
+自定义字体颜色的可选择颜色数组
+
+##### popoverProps <Badge type="danger" text="Omit<NonNullable<MenuPropsType['popoverProps']>, 'onShow' | 'onShowing' | 'onShown' | 'onHide' | 'onHiding' | 'onHidden'>" />
+
+浮层属性配置，参考 `Menu` 的 `popoverProps` 属性

package/docs/menus/built-in/decrease-indent.md

@@ -0,0 +1,29 @@
+---
+title: decrease-indent 减少缩进
+---
+
+# decrease-indent 减少缩进
+
+减少块节点的缩进
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, DecreaseIndentMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<DecreaseIndentMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### shortcut <Badge type="danger" text="(e: KeyboardEvent) => boolean" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/emoji.md

@@ -0,0 +1,35 @@
+---
+title: emoji 表情
+---
+
+# emoji 表情
+
+插入表情
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, EmojiMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<EmojiMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### data <Badge type="danger" text="string[]" />
+
+自定义可选择的 `emoji` 表情列表，默认数据如下：
+
+['😀', '😃', '😄', '😁', '😆', '😅', '😂', '🤣', '😊', '😇', '😉', '😍', '😘', '😗', '😚', '🥰', '😋', '😜', '🤪', '🤨', '😭', '😢', '😔', '😞', '😰', '😱', '😨', '😳', '😡', '😠', '🤬', '👍', '👎', '👏', '🙌', '👐', '🤝', '✌', '🤞', '🤘', '❤️', '💕', '💖', '💗', '💘', '💔', '❣', '🖤', '💙', '💚', '🍏', '🍎', '🍌', '🍉', '🍇', '🍓', '🍒', '🍑', '🍕', '🍔', '🍟', '🌭', '🍗', '🍞', '🚗', '🚕', '🚙', '🚌', '🚑', '🚓', '🚚', '🚲', '🚜', '🚂', '✈️', '🚀', '🎉', '🎊', '🎁', '🔥', '🌈', '⭐', '💡', '⏰', '📅', '📌', '🎶', '🎵']
+
+##### popoverProps <Badge type="danger" text="Omit<NonNullable<MenuPropsType['popoverProps']>, 'onShow' | 'onShowing' | 'onShown' | 'onHide' | 'onHiding' | 'onHidden'>" />
+
+浮层属性配置，参考 `Menu` 的 `popoverProps` 属性

package/docs/menus/built-in/font-family.md

@@ -0,0 +1,44 @@
+---
+title: font-family 字体
+---
+
+# font-family 字体
+
+设置/取消文本的字体
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, FontFamilyMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<FontFamilyMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### data <Badge type="danger" text="MenuDataType[]" />
+
+自定义可选择的字体列表，同 `Menu` 组件的 `data` 参数类型，如：
+
+```json
+[
+  { "label": "楷体", "value": "楷体,楷体-简" },
+  { "label": "宋体", "value": "宋体,宋体-简" }
+]
+```
+
+##### popoverProps <Badge type="danger" text="Omit<NonNullable<MenuPropsType['popoverProps']>, 'onShow' | 'onShowing' | 'onShown' | 'onHide' | 'onHiding' | 'onHidden'>" />
+
+浮层属性配置，参考 `Menu` 的 `popoverProps` 属性
+
+##### shortcut <Badge type="danger" text="{ [key: MenuDataType['value']]: (e: KeyboardEvent) => boolean }" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/font-size.md

@@ -0,0 +1,44 @@
+---
+title: font-size 字号
+---
+
+# font-size 字号
+
+设置/取消文本的字号
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, FontSizeMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<FontSizeMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### data <Badge type="danger" text="MenuDataType[]" />
+
+自定义可选择的字号列表，同 `Menu` 组件的 `data` 参数类型，如：
+
+```json
+[
+  { "label": "14px", "value": "14px" },
+  { "label": "20px", "value": "20px" }
+]
+```
+
+##### popoverProps <Badge type="danger" text="Omit<NonNullable<MenuPropsType['popoverProps']>, 'onShow' | 'onShowing' | 'onShown' | 'onHide' | 'onHiding' | 'onHidden'>" />
+
+浮层属性配置，参考 `Menu` 的 `popoverProps` 属性
+
+##### shortcut <Badge type="danger" text="{ [key: MenuDataType['value']]: (e: KeyboardEvent) => boolean }" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/full-screen.md

@@ -0,0 +1,39 @@
+---
+title: full-screen 全屏功能
+---
+
+# full-screen 全屏功能
+
+设置/取消编辑器的全屏效果
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, FullScreenMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<FullScreenMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### target <Badge type="danger" text="string" />
+
+必填属性，该菜单在进行全屏设置时需要指定的 `dom`，这个 `dom` 应当包裹住了编辑器。
+
+由于在真实的 `dom` 渲染中，`before` 和 `after` 插槽的内容都是在编辑区域之外的，所以若是希望合理地使用全屏功能，需要使用一个 `dom` 包裹住整个编辑器包括 `before` 和 `after` 的区域
+
+##### zIndex <Badge type="danger" text="number" />
+
+全屏 `dom` 的 `z-index` 设置，默认为 `100`
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### shortcut <Badge type="danger" text="(e: KeyboardEvent) => boolean" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)

package/docs/menus/built-in/heading.md

@@ -0,0 +1,66 @@
+---
+title: heading 标题
+---
+
+# heading 标题
+
+设置/取消标题
+
+## 使用方法
+
+```tsx
+import { useState } from 'react'
+import { Wrapper, HeadingMenu } from '@kaitify/react'
+
+export default function App() {
+  const [content, setContent] = useState('<p>hello</p>')
+  return <Wrapper value={content} onChange={v => setContent(v)} before={<HeadingMenu />}></Wrapper>
+}
+```
+
+## Props 参数
+
+##### disabled <Badge type="danger" text="boolean" />
+
+是否禁用该菜单，默认为 `false`
+
+##### data <Badge type="danger" text="MenuDataType[]" />
+
+自定义可选择的标题列表，同 `Menu` 组件的 `data` 参数类型，标题的值只支持从 1-6，如：
+
+```json
+[
+  {
+    "label": "一级标题",
+    "value": 1
+  },
+  {
+    "label": "二级标题",
+    "value": 2
+  },
+  {
+    "label": "三级标题",
+    "value": 3
+  },
+  {
+    "label": "四级标题",
+    "value": 4
+  },
+  {
+    "label": "五级标题",
+    "value": 5
+  },
+  {
+    "label": "六级标题",
+    "value": 6
+  }
+]
+```
+
+##### popoverProps <Badge type="danger" text="Omit<NonNullable<MenuPropsType['popoverProps']>, 'onShow' | 'onShowing' | 'onShown' | 'onHide' | 'onHiding' | 'onHidden'>" />
+
+浮层属性配置，参考 `Menu` 的 `popoverProps` 属性
+
+##### shortcut <Badge type="danger" text="{ [key: MenuDataType['value']]: (e: KeyboardEvent) => boolean }" />
+
+菜单快捷键实现，继承自 `Menu` 组件的同名属性，具体使用可参考 [Menu 组件的 shortcut](/guide/menu#shortcut)