x-star-editor 0.0.9 → 0.1.0

package/dist/{XStarMdEditor → x-star-md-editor}/index.d.ts

@@ -1,15 +1,15 @@
 import React from 'react';
-import type { ToolbarItem } from '../components/Toolbar';
+import type { ToolbarItemMap, ToolbarItems } from '../components/Toolbar';
 import type { Executor, KeyboardEventHandler } from '../utils/handler';
 interface EditorOptions {
     /**
      * 工具栏项映射
      */
-    toolbarItemMap: Partial<Record<string, ToolbarItem>>;
+    toolbarItemMap: ToolbarItemMap;
     /**
      * 工具栏项
      */
-    toolbarItems: (string | ToolbarItem)[][];
+    toolbarItems: ToolbarItems;
     /**
      * 键盘事件处理函数
      */
@@ -23,13 +23,41 @@ export interface XStarMdEditorHandle {
     getContainer: () => HTMLDivElement | null;
 }
 export interface XStarMdEditorProps {
+    /**
+     * CSS 类名
+     */
     className?: string;
+    /**
+     * CSS 样式
+     */
     style?: React.CSSProperties;
+    /**
+     * 工具栏 CSS 类名
+     */
     toolbarClassName?: string;
+    /**
+     * 工具栏 CSS 样式
+     */
     toolbarStyle?: React.CSSProperties;
+    /**
+     * 语言
+     */
+    locale?: string;
+    /**
+     * 初始文本
+     */
     initialValue?: string;
+    /**
+     * 插件
+     */
     plugins?: XStarMdEditorPlugin[];
+    /**
+     * 文本变化回调函数
+     */
     onChange?: (value: string) => void;
+    /**
+     * 文件插入回调函数
+     */
     onInsertFile?: (file: File, options: {
         description: string;
         image: boolean;

package/dist/{XStarMdEditor → x-star-md-editor}/index.js

@@ -1,7 +1,8 @@
 import classNames from 'classnames';
 import React, { useEffect, useImperativeHandle, useRef } from 'react';
 import Toolbar, { getDefaultToolbarItemMap, getDefaultToolbarItems } from "../components/Toolbar";
-import { createSelection, getRange, useContainer } from "../utils/container";
+import { LocaleProvider } from "../locales";
+import { getRange, useContainer } from "../utils/container";
 import { prefix } from "../utils/global";
 import { composeHandlers, getDefaultKeyboardEventHandlers } from "../utils/handler";
 import { useHistory } from "../utils/history";
@@ -10,6 +11,7 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     style = _ref.style,
     toolbarClassName = _ref.toolbarClassName,
     toolbarStyle = _ref.toolbarStyle,
+    locale = _ref.locale,
     _ref$initialValue = _ref.initialValue,
     initialValue = _ref$initialValue === void 0 ? '' : _ref$initialValue,
     plugins = _ref.plugins,
@@ -17,6 +19,7 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     onInsertFile = _ref.onInsertFile;
   var container = useContainer();
   var _useHistory = useHistory(initialValue),
+    history = _useHistory.history,
     sourceCode = _useHistory.sourceCode,
     selection = _useHistory.selection,
     dispatch = _useHistory.dispatch;
@@ -47,13 +50,15 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       initialized.current = false;
     };
   }, []);
+  var historyLatest = useRef(history);
+  historyLatest.current = history;
   var sourceCodeLatest = useRef(sourceCode);
   sourceCodeLatest.current = sourceCode;
 
   /**
    * 失焦时的选区
    */
-  var blurSelection = useRef();
+  var blurSelection = useRef(selection);
 
   /**
    * 获取选区，如果焦点不在容器内，则返回失焦时的选区
@@ -61,12 +66,12 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
    * @returns 选区
    */
   var getSelection = function getSelection() {
-    var _blurSelection$curren;
     var selection = container.getSelection();
-    return selection.anchorOffset === -1 || selection.focusOffset === -1 ? (_blurSelection$curren = blurSelection.current) !== null && _blurSelection$curren !== void 0 ? _blurSelection$curren : createSelection(sourceCodeLatest.current.length) : selection;
+    return selection.anchorOffset === -1 || selection.focusOffset === -1 ? blurSelection.current : selection;
   };
   var exec = useRef(function (handler) {
     return handler({
+      history: historyLatest.current,
       sourceCode: sourceCodeLatest.current,
       selection: getSelection(),
       dispatch: dispatch
@@ -141,7 +146,8 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
               },
               selection: compositionStartSelection.current
             });
-            setTimeout(function () {
+            // 确保组合事件屏蔽表单和键盘事件
+            window.setTimeout(function () {
               return compositionStartSelection.current = undefined;
             });
           }
@@ -159,7 +165,7 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       case 'drop':
         {
           var _selection = getSelection();
-          setTimeout(function () {
+          window.setTimeout(function () {
             container.normalize();
             dispatch({
               type: 'set',
@@ -179,7 +185,7 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       case 'blur':
         {
           blurSelection.current = getSelection();
-          setTimeout(function () {
+          window.setTimeout(function () {
             compositionStartSelection.current = undefined;
             container.setText(sourceCodeLatest.current);
           });
@@ -195,13 +201,11 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       case 'beforeinput':
         {
           e.preventDefault();
-          var _ref2 = e,
-            data = _ref2.data;
-          if (data) {
+          if ('data' in e && typeof e.data === 'string') {
             dispatch({
               type: 'insert',
               payload: {
-                text: data
+                text: e.data
               },
               selection: getSelection()
             });
@@ -211,7 +215,7 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     }
   };
   var _composeHandlers = composeHandlers(plugins)({
-      toolbarItemMap: getDefaultToolbarItemMap(onInsertFile),
+      toolbarItemMap: getDefaultToolbarItemMap(locale, onInsertFileLatest.current),
       toolbarItems: getDefaultToolbarItems(),
       keyboardEventHandlers: getDefaultKeyboardEventHandlers()
     }),
@@ -226,6 +230,7 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       case 'keydown':
         {
           composeHandlers(keyboardEventHandlers)({
+            history: historyLatest.current,
             sourceCode: sourceCodeLatest.current,
             selection: getSelection(),
             dispatch: dispatch,
@@ -235,7 +240,9 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
         }
     }
   };
-  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Toolbar, {
+  return /*#__PURE__*/React.createElement(LocaleProvider, {
+    locale: locale
+  }, /*#__PURE__*/React.createElement(Toolbar, {
     className: classNames(toolbarClassName),
     style: toolbarStyle,
     itemMap: toolbarItemMap,
@@ -257,7 +264,9 @@ var XStarMdEditor = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     onPaste: clipboardEventHandler
   }));
 });
-XStarMdEditor.displayName = 'XStarMdEditor';
+if (process.env.NODE_ENV !== 'production') {
+  XStarMdEditor.displayName = 'XStarMdEditor';
+}
 export default XStarMdEditor;
 export var useMdEditorRef = function useMdEditorRef() {
   return useRef(null);

package/dist/{XStarMdViewer → x-star-md-viewer}/index.d.ts

@@ -7,9 +7,21 @@ export interface XStarMdViewerHandle {
     getContainer: () => HTMLDivElement | null;
 }
 export interface XStarMdViewerProps {
+    /**
+     * CSS 类名
+     */
     className?: string;
+    /**
+     * CSS 样式
+     */
     style?: React.CSSProperties;
+    /**
+     * 文本
+     */
     value?: string;
+    /**
+     * 插件
+     */
     plugins?: XStarMdViewerPlugin[];
 }
 declare const XStarMdViewer: React.ForwardRefExoticComponent<XStarMdViewerProps & React.RefAttributes<XStarMdViewerHandle>>;

package/dist/{XStarMdViewer → x-star-md-viewer}/index.js

@@ -27,7 +27,9 @@ var XStarMdViewer = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     customBlocks: {}
   })));
 });
-XStarMdViewer.displayName = 'XStarMdViewer';
+if (process.env.NODE_ENV !== 'production') {
+  XStarMdViewer.displayName = 'XStarMdViewer';
+}
 export default XStarMdViewer;
 export var useMdViewerRef = function useMdViewerRef() {
   return useRef(null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x-star-editor",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "description": "An editor developed by turingstar",
   "license": "MIT",
   "module": "dist/index.js",
@@ -9,13 +9,13 @@
     "dist"
   ],
   "scripts": {
-    "build": "father build && sass src/styles/index.scss dist/styles/index.css --no-source-map",
+    "build": "father build && sass src:dist --no-source-map",
     "build:watch": "father dev",
     "dev": "dumi dev",
     "docs:build": "dumi build",
     "doctor": "father doctor",
     "lint": "npm run lint:es && npm run lint:css",
-    "lint:css": "stylelint \"{src,test}/**/*.{css,less}\"",
+    "lint:css": "stylelint \"{src,test}/**/*.{css,scss}\"",
     "lint:es": "eslint \"{src,test}/**/*.{js,jsx,ts,tsx}\"",
     "prepare": "husky install && dumi setup",
     "prepublishOnly": "father doctor && npm run build",
@@ -30,7 +30,7 @@
     "*.{md,json}": [
       "prettier --write --no-error-on-unmatched-pattern"
     ],
-    "*.{css,less}": [
+    "*.{css,scss}": [
       "stylelint --fix",
       "prettier --write"
     ],
@@ -58,6 +58,7 @@
     "remark-parse": "^10.0.2",
     "remark-rehype": "^10.1.0",
     "remark-stringify": "^10.0.3",
+    "strip-markdown": "^5.0.1",
     "unified": "^10.1.2"
   },
   "devDependencies": {
@@ -80,6 +81,7 @@
     "react-dom": "^18.0.0",
     "styled-components": "^6.0.7",
     "stylelint": "^14.9.1",
+    "stylelint-config-standard-scss": "^6.1.0",
     "typescript": "^5.1.6",
     "webpack": "^5.88.2"
   },

package/dist/styles/icons/bold.svg

@@ -1 +0,0 @@
-<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1681626310611" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="8363" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="200"><path d="M697.8 481.4c33.6-35 54.2-82.3 54.2-134.3v-10.2C752 229.3 663.9 142 555.3 142H259.4c-15.1 0-27.4 12.3-27.4 27.4v679.1c0 16.3 13.2 29.5 29.5 29.5h318.7c117 0 211.8-94.2 211.8-210.5v-11c0-73-37.4-137.3-94.2-175.1zM328 238h224.7c57.1 0 103.3 44.4 103.3 99.3v9.5c0 54.8-46.3 99.3-103.3 99.3H328V238z m366.6 429.4c0 62.9-51.7 113.9-115.5 113.9H328V542.7h251.1c63.8 0 115.5 51 115.5 113.9v10.8z" p-id="8364"></path></svg>

package/dist/styles/icons/code-library.svg

@@ -1 +0,0 @@
-<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1681627986714" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="9340" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="200"><path d="M516 673c0 4.4 3.4 8 7.5 8h185c4.1 0 7.5-3.6 7.5-8v-48c0-4.4-3.4-8-7.5-8h-185c-4.1 0-7.5 3.6-7.5 8v48zM321.1 679.1l192-161c3.8-3.2 3.8-9.1 0-12.3l-192-160.9c-5.2-4.4-13.1-0.7-13.1 6.1v62.7c0 2.4 1 4.6 2.9 6.1L420.7 512l-109.8 92.2c-1.8 1.5-2.9 3.8-2.9 6.1V673c0 6.8 7.9 10.5 13.1 6.1z" p-id="9341"></path><path d="M880 112H144c-17.7 0-32 14.3-32 32v736c0 17.7 14.3 32 32 32h736c17.7 0 32-14.3 32-32V144c0-17.7-14.3-32-32-32z m-40 728H184V184h656v656z" p-id="9342"></path></svg>

package/dist/styles/icons/italic.svg

@@ -1 +0,0 @@
-<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1681626574917" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="8502" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="200"><path d="M798 160H366c-4.4 0-8 3.6-8 8v64c0 4.4 3.6 8 8 8h181.2l-156 544H229c-4.4 0-8 3.6-8 8v64c0 4.4 3.6 8 8 8h432c4.4 0 8-3.6 8-8v-64c0-4.4-3.6-8-8-8H474.4l156-544H798c4.4 0 8-3.6 8-8v-64c0-4.4-3.6-8-8-8z" p-id="8503"></path></svg>

package/dist/styles/icons/strikethrough.svg

@@ -1 +0,0 @@
-<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1681626588137" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="8781" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="200"><path d="M952 474H569.9c-10-2-20.5-4-31.6-6-15.9-2.9-22.2-4.1-30.8-5.8-51.3-10-82.2-20-106.8-34.2-35.1-20.5-52.2-48.3-52.2-85.1 0-37 15.2-67.7 44-89 28.4-21 68.8-32.1 116.8-32.1 54.8 0 97.1 14.4 125.8 42.8 14.6 14.4 25.3 32.1 31.8 52.6 1.3 4.1 2.8 10 4.3 17.8 0.9 4.8 5.2 8.2 9.9 8.2h72.8c5.6 0 10.1-4.6 10.1-10.1v-1c-0.7-6.8-1.3-12.1-2-16-7.3-43.5-28-81.7-59.7-110.3-44.4-40.5-109.7-61.8-188.7-61.8-72.3 0-137.4 18.1-183.3 50.9-25.6 18.4-45.4 41.2-58.6 67.7-13.5 27.1-20.3 58.4-20.3 92.9 0 29.5 5.7 54.5 17.3 76.5 8.3 15.7 19.6 29.5 34.1 42H72c-4.4 0-8 3.6-8 8v60c0 4.4 3.6 8 8 8h433.2c2.1 0.4 3.9 0.8 5.9 1.2 30.9 6.2 49.5 10.4 66.6 15.2 23 6.5 40.6 13.3 55.2 21.5 35.8 20.2 53.3 49.2 53.3 89 0 35.3-15.5 66.8-43.6 88.8-30.5 23.9-75.6 36.4-130.5 36.4-43.7 0-80.7-8.5-110.2-25-29.1-16.3-49.1-39.8-59.7-69.5-0.8-2.2-1.7-5.2-2.7-9-1.2-4.4-5.3-7.5-9.7-7.5h-79.7c-5.6 0-10.1 4.6-10.1 10.1v1c0.2 2.3 0.4 4.2 0.6 5.7 6.5 48.8 30.3 88.8 70.7 118.8 47.1 34.8 113.4 53.2 191.8 53.2 84.2 0 154.8-19.8 204.2-57.3 25-18.9 44.2-42.2 57.1-69 13-27.1 19.7-57.9 19.7-91.5 0-31.8-5.8-58.4-17.8-81.4-5.8-11.2-13.1-21.5-21.8-30.8H952c4.4 0 8-3.6 8-8v-60c0-4.3-3.6-7.9-8-7.9z" p-id="8782"></path></svg>