@uiw/react-md-editor 4.0.6 → 4.0.8

package/lib/index.d.ts

@@ -2,6 +2,7 @@ import MDEditor from './Editor';
 import * as commands from './commands/';
 import * as MarkdownUtil from './utils/markdownUtils';
 import './index.less';
+export { headingExecute } from './commands/title';
 export * from './commands/';
 export * from './commands/group';
 export * from './utils/markdownUtils';

package/lib/index.js

@@ -6,9 +6,16 @@ Object.defineProperty(exports, "__esModule", {
 });
 var _exportNames = {
   commands: true,
-  MarkdownUtil: true
+  MarkdownUtil: true,
+  headingExecute: true
 };
 exports["default"] = exports.commands = exports.MarkdownUtil = void 0;
+Object.defineProperty(exports, "headingExecute", {
+  enumerable: true,
+  get: function get() {
+    return _title.headingExecute;
+  }
+});
 var _Editor = _interopRequireWildcard(require("./Editor"));
 Object.keys(_Editor).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -47,6 +54,7 @@ Object.keys(MarkdownUtil).forEach(function (key) {
     }
   });
 });
+var _title = require("./commands/title");
 var _group = require("./commands/group");
 Object.keys(_group).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/nohighlight.d.ts

@@ -2,12 +2,14 @@ declare module '@uiw/react-md-editor/nohighlight' {
   import MDEditor from '@uiw/react-md-editor/esm/Editor.nohighlight';
   import * as commands from '@uiw/react-md-editor/esm/commands';
   import * as MarkdownUtil from '@uiw/react-md-editor/esm/utils/markdownUtils';
+  export { headingExecute } from '@uiw/react-md-editor/esm/commands/title';
   export * from '@uiw/react-md-editor/esm/commands';
   export * from '@uiw/react-md-editor/esm/commands/group';
   export * from '@uiw/react-md-editor/esm/utils/markdownUtils';
   export * from '@uiw/react-md-editor/esm/utils/InsertTextAtPosition';
   export * from '@uiw/react-md-editor/esm/Editor.nohighlight';
   export * from '@uiw/react-md-editor/esm/Context';
+  export * from '@uiw/react-md-editor/esm/Types';
   export { MarkdownUtil, commands };
   export default MDEditor;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uiw/react-md-editor",
-  "version": "4.0.6",
+  "version": "4.0.8",
   "description": "A markdown editor with preview, implemented with React.js and TypeScript.",
   "homepage": "https://uiwjs.github.io/react-md-editor/",
   "funding": "https://jaywcjlove.github.io/#/sponsor",

package/src/Context.tsx

@@ -14,6 +14,7 @@ export interface ContextStore {
   fullscreen?: boolean;
   highlightEnable?: boolean;
   autoFocus?: boolean;
+  autoFocusEnd?: boolean;
   textarea?: HTMLTextAreaElement;
   commandOrchestrator?: TextAreaCommandOrchestrator;
   textareaWarp?: HTMLDivElement;

package/src/Editor.nohighlight.tsx

@@ -38,6 +38,7 @@ const InternalMDEditor = React.forwardRef<RefMDEditor, MDEditorProps>(
       maxHeight = 1200,
       minHeight = 100,
       autoFocus,
+      autoFocusEnd = false,
       tabSize = 2,
       defaultTabEnable = false,
       onChange,
@@ -117,6 +118,7 @@ const InternalMDEditor = React.forwardRef<RefMDEditor, MDEditorProps>(
     );
     // eslint-disable-next-line react-hooks/exhaustive-deps
     useMemo(() => autoFocus !== state.autoFocus && dispatch({ autoFocus: autoFocus }), [autoFocus]);
+    useMemo(() => autoFocusEnd !== state.autoFocusEnd && dispatch({ autoFocusEnd: autoFocusEnd }), [autoFocusEnd]);
     useMemo(
       () => fullscreen !== state.fullscreen && dispatch({ fullscreen: fullscreen }),
       // eslint-disable-next-line react-hooks/exhaustive-deps

package/src/Editor.tsx

@@ -38,6 +38,7 @@ const InternalMDEditor = React.forwardRef<RefMDEditor, MDEditorProps>(
       maxHeight = 1200,
       minHeight = 100,
       autoFocus,
+      autoFocusEnd = false,
       tabSize = 2,
       defaultTabEnable = false,
       onChange,
@@ -117,6 +118,7 @@ const InternalMDEditor = React.forwardRef<RefMDEditor, MDEditorProps>(
     );
     // eslint-disable-next-line react-hooks/exhaustive-deps
     useMemo(() => autoFocus !== state.autoFocus && dispatch({ autoFocus: autoFocus }), [autoFocus]);
+    useMemo(() => autoFocusEnd !== state.autoFocusEnd && dispatch({ autoFocusEnd: autoFocusEnd }), [autoFocusEnd]);
     useMemo(
       () => fullscreen !== state.fullscreen && dispatch({ fullscreen: fullscreen }),
       // eslint-disable-next-line react-hooks/exhaustive-deps

package/src/Types.ts

@@ -37,6 +37,10 @@ export interface MDEditorProps extends Omit<React.HTMLAttributes<HTMLDivElement>
    * or it has an `autofocus` attribute and no other element is focused.
    */
   autoFocus?: ITextAreaProps['autoFocus'];
+  /**
+   * Can be used to make `Markdown Editor` focus on the end of text on initialization.
+   */
+  autoFocusEnd?: boolean;
   /**
    * The height of the editor.
    * ⚠️ `Dragbar` is invalid when **`height`** parameter percentage.
@@ -55,7 +59,7 @@ export interface MDEditorProps extends Omit<React.HTMLAttributes<HTMLDivElement>
    */
   visibleDragbar?: boolean;
   /**
-   * @deprecated use `visibleDragbar`
+   * @deprecated use {@link MDEditorProps.visibleDragbar}
    */
   visiableDragbar?: boolean;
   /**
@@ -88,7 +92,7 @@ export interface MDEditorProps extends Omit<React.HTMLAttributes<HTMLDivElement>
   textareaProps?: ITextAreaProps;
   /**
    * Use div to replace TextArea or re-render TextArea
-   * @deprecated Please use ~~`renderTextarea`~~ -> `components`
+   * @deprecated Please use {@link components}
    */
   renderTextarea?: ITextAreaProps['renderTextarea'];
   /**

package/src/commands/index.cn.ts

@@ -46,7 +46,7 @@ let fullscreen: ICommand = {
   ...fullscreenInit,
   buttonProps: { 'aria-label': '切换全屏(ctrl + 0)', title: '切换全屏(ctrl + 0)' },
 };
-let hr: ICommand = { ...hrInit, buttonProps: { 'aria-label': '插入HR (ctrl + h)', title: '插入HR (ctrl + h)' } };
+let hr: ICommand = { ...hrInit, buttonProps: { 'aria-label': '插入分割线 (ctrl + h)', title: '插入分割线 (ctrl + h)' } };
 let image: ICommand = {
   ...imageInit,
   buttonProps: { 'aria-label': '添加图像(ctrl + k)', title: '添加图像(ctrl + k)' },
@@ -91,8 +91,8 @@ let quote: ICommand = {
 let strikethrough: ICommand = {
   ...strikethroughInit,
   buttonProps: {
-    'aria-label': 'Add strikethrough text (ctrl + shift + x)',
-    title: 'Add strikethrough text (ctrl + shift + x)',
+    'aria-label': '添加删除线文本 (ctrl + shift + x)',
+    title: '添加删除线文本 (ctrl + shift + x)',
   },
 };
 let issue: ICommand = { ...issueInit, buttonProps: { 'aria-label': '添加 issue', title: '添加 issue' } };

package/src/commands/index.ts

@@ -15,13 +15,13 @@ import { checkedListCommand, orderedListCommand, unorderedListCommand } from './
 import { codeEdit, codeLive, codePreview } from './preview';
 import { quote } from './quote';
 import { strikethrough } from './strikeThrough';
-import { title } from './title';
-import { title1 } from './title1';
-import { title2 } from './title2';
-import { title3 } from './title3';
-import { title4 } from './title4';
-import { title5 } from './title5';
-import { title6 } from './title6';
+import { title, heading } from './title';
+import { title1, heading1 } from './title1';
+import { title2, heading2 } from './title2';
+import { title3, heading3 } from './title3';
+import { title4, heading4 } from './title4';
+import { title5, heading5 } from './title5';
+import { title6, heading6 } from './title6';
 import { table } from './table';
 import { issue } from './issue';
 import { help } from './help';
@@ -188,6 +188,13 @@ export {
   title4,
   title5,
   title6,
+  heading,
+  heading1,
+  heading2,
+  heading3,
+  heading4,
+  heading5,
+  heading6,
   bold,
   codeBlock,
   comment,

package/src/commands/title.tsx

@@ -1,9 +1,9 @@
 import React from 'react';
 import { ICommand, ExecuteState, TextAreaTextApi } from './';
-import { title1 } from './title1';
+import { heading1 } from './title1';
 import { selectLine, executeCommand } from '../utils/markdownUtils';
 
-export function titleExecute({
+export function headingExecute({
   state,
   api,
   prefix,
@@ -19,8 +19,8 @@ export function titleExecute({
   executeCommand({ api, selectedText: state1.selectedText, selection: state.selection, prefix, suffix });
 }
 
-export const title: ICommand = {
-  ...title1,
+export const heading: ICommand = {
+  ...heading1,
   icon: (
     <svg width="12" height="12" viewBox="0 0 520 520">
       <path
@@ -30,3 +30,10 @@ export const title: ICommand = {
     </svg>
   ),
 };
+
+/**
+ * @deprecated Use `heading` instead.
+ * This command is now deprecated and will be removed in future versions.
+ * Use `title` for inserting headings.
+ */
+export const title: ICommand = heading;

package/src/commands/title1.tsx

@@ -1,16 +1,23 @@
 import React from 'react';
-import { titleExecute } from '../commands/title';
+import { headingExecute } from '../commands/title';
 import { ICommand, ExecuteState, TextAreaTextApi } from './';
 
-export const title1: ICommand = {
-  name: 'title1',
-  keyCommand: 'title1',
+export const heading1: ICommand = {
+  name: 'heading1',
+  keyCommand: 'heading1',
   shortcuts: 'ctrlcmd+1',
   prefix: '# ',
   suffix: '',
-  buttonProps: { 'aria-label': 'Insert title1 (ctrl + 1)', title: 'Insert title1 (ctrl + 1)' },
-  icon: <div style={{ fontSize: 18, textAlign: 'left' }}>Title 1</div>,
+  buttonProps: { 'aria-label': 'Insert Heading 1 (ctrl + 1)', title: 'Insert Heading 1 (ctrl + 1)' },
+  icon: <div style={{ fontSize: 18, textAlign: 'left' }}>Heading 1</div>,
   execute: (state: ExecuteState, api: TextAreaTextApi) => {
-    titleExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
+    headingExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
   },
 };
+
+/**
+ * @deprecated Use `heading1` instead.
+ * This command is now deprecated and will be removed in future versions.
+ * Use `title1` for inserting Heading 1.
+ */
+export const title1: ICommand = heading1;

package/src/commands/title2.tsx

@@ -1,16 +1,23 @@
 import React from 'react';
-import { titleExecute } from '../commands/title';
+import { headingExecute } from '../commands/title';
 import { ICommand, ExecuteState, TextAreaTextApi } from './';
 
-export const title2: ICommand = {
-  name: 'title2',
-  keyCommand: 'title2',
+export const heading2: ICommand = {
+  name: 'heading2',
+  keyCommand: 'heading2',
   shortcuts: 'ctrlcmd+2',
   prefix: '## ',
   suffix: '',
-  buttonProps: { 'aria-label': 'Insert title2 (ctrl + 2)', title: 'Insert title2 (ctrl + 2)' },
-  icon: <div style={{ fontSize: 16, textAlign: 'left' }}>Title 2</div>,
+  buttonProps: { 'aria-label': 'Insert Heading 2 (ctrl + 2)', title: 'Insert Heading 2 (ctrl + 2)' },
+  icon: <div style={{ fontSize: 16, textAlign: 'left' }}>Heading 2</div>,
   execute: (state: ExecuteState, api: TextAreaTextApi) => {
-    titleExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
+    headingExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
   },
 };
+
+/**
+ * @deprecated Use `heading2` instead.
+ * This command is now deprecated and will be removed in future versions.
+ * Use `title2` for inserting Heading 2.
+ */
+export const title2: ICommand = heading2;

package/src/commands/title3.tsx

@@ -1,16 +1,23 @@
 import React from 'react';
-import { titleExecute } from '../commands/title';
+import { headingExecute } from '../commands/title';
 import { ICommand, ExecuteState, TextAreaTextApi } from './';
 
-export const title3: ICommand = {
-  name: 'title3',
-  keyCommand: 'title3',
+export const heading3: ICommand = {
+  name: 'heading3',
+  keyCommand: 'heading3',
   shortcuts: 'ctrlcmd+3',
   prefix: '### ',
   suffix: '',
-  buttonProps: { 'aria-label': 'Insert title3 (ctrl + 3)', title: 'Insert title3 (ctrl + 3)' },
-  icon: <div style={{ fontSize: 15, textAlign: 'left' }}>Title 3</div>,
+  buttonProps: { 'aria-label': 'Insert Heading 3 (ctrl + 3)', title: 'Insert Heading 3 (ctrl + 3)' },
+  icon: <div style={{ fontSize: 15, textAlign: 'left' }}>Heading 3</div>,
   execute: (state: ExecuteState, api: TextAreaTextApi) => {
-    titleExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
+    headingExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
   },
 };
+
+/**
+ * @deprecated Use `heading3` instead.
+ * This command is now deprecated and will be removed in future versions.
+ * Use `title3` for inserting Heading 3.
+ */
+export const title3: ICommand = heading3;

package/src/commands/title4.tsx

@@ -1,16 +1,23 @@
 import React from 'react';
-import { titleExecute } from '../commands/title';
+import { headingExecute } from '../commands/title';
 import { ICommand, ExecuteState, TextAreaTextApi } from './';
 
-export const title4: ICommand = {
-  name: 'title4',
-  keyCommand: 'title4',
+export const heading4: ICommand = {
+  name: 'heading4',
+  keyCommand: 'heading4',
   shortcuts: 'ctrlcmd+4',
   prefix: '#### ',
   suffix: '',
-  buttonProps: { 'aria-label': 'Insert title4 (ctrl + 4)', title: 'Insert title4 (ctrl + 4)' },
-  icon: <div style={{ fontSize: 14, textAlign: 'left' }}>Title 4</div>,
+  buttonProps: { 'aria-label': 'Insert Heading 4 (ctrl + 4)', title: 'Insert Heading 4 (ctrl + 4)' },
+  icon: <div style={{ fontSize: 14, textAlign: 'left' }}>Heading 4</div>,
   execute: (state: ExecuteState, api: TextAreaTextApi) => {
-    titleExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
+    headingExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
   },
 };
+
+/**
+ * @deprecated Use `heading4` instead.
+ * This command is now deprecated and will be removed in future versions.
+ * Use `title4` for inserting Heading 4.
+ */
+export const title4: ICommand = heading4;

package/src/commands/title5.tsx

@@ -1,16 +1,23 @@
 import React from 'react';
-import { titleExecute } from '../commands/title';
+import { headingExecute } from '../commands/title';
 import { ICommand, ExecuteState, TextAreaTextApi } from './';
 
-export const title5: ICommand = {
-  name: 'title5',
-  keyCommand: 'title5',
+export const heading5: ICommand = {
+  name: 'heading5',
+  keyCommand: 'heading5',
   shortcuts: 'ctrlcmd+5',
   prefix: '##### ',
   suffix: '',
-  buttonProps: { 'aria-label': 'Insert title5 (ctrl + 5)', title: 'Insert title5 (ctrl + 5)' },
-  icon: <div style={{ fontSize: 12, textAlign: 'left' }}>Title 5</div>,
+  buttonProps: { 'aria-label': 'Insert Heading 5 (ctrl + 5)', title: 'Insert Heading 5 (ctrl + 5)' },
+  icon: <div style={{ fontSize: 12, textAlign: 'left' }}>Heading 5</div>,
   execute: (state: ExecuteState, api: TextAreaTextApi) => {
-    titleExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
+    headingExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
   },
 };
+
+/**
+ * @deprecated Use `heading5` instead.
+ * This command is now deprecated and will be removed in future versions.
+ * Use `title5` for inserting Heading 5.
+ */
+export const title5: ICommand = heading5;

package/src/commands/title6.tsx

@@ -1,16 +1,23 @@
 import React from 'react';
-import { titleExecute } from '../commands/title';
+import { headingExecute } from '../commands/title';
 import { ICommand, ExecuteState, TextAreaTextApi } from './';
 
-export const title6: ICommand = {
-  name: 'title6',
-  keyCommand: 'title6',
+export const heading6: ICommand = {
+  name: 'heading6',
+  keyCommand: 'heading6',
   shortcuts: 'ctrlcmd+6',
   prefix: '###### ',
   suffix: '',
-  buttonProps: { 'aria-label': 'Insert title6 (ctrl + 6)', title: 'Insert title6 (ctrl + 6)' },
-  icon: <div style={{ fontSize: 12, textAlign: 'left' }}>Title 6</div>,
+  buttonProps: { 'aria-label': 'Insert Heading 6 (ctrl + 6)', title: 'Insert Heading 6 (ctrl + 6)' },
+  icon: <div style={{ fontSize: 12, textAlign: 'left' }}>Heading 6</div>,
   execute: (state: ExecuteState, api: TextAreaTextApi) => {
-    titleExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
+    headingExecute({ state, api, prefix: state.command.prefix!, suffix: state.command.suffix });
   },
 };
+
+/**
+ * @deprecated Use `heading6` instead.
+ * This command is now deprecated and will be removed in future versions.
+ * Use `title6` for inserting Heading 6.
+ */
+export const title6: ICommand = heading6;

package/src/components/TextArea/Textarea.tsx

@@ -19,6 +19,8 @@ export default function Textarea(props: TextAreaProps) {
     extraCommands,
     tabSize,
     defaultTabEnable,
+    autoFocusEnd,
+    textareaWarp,
     dispatch,
     ...otherStore
   } = useContext(EditorContext);
@@ -39,6 +41,22 @@ export default function Textarea(props: TextAreaProps) {
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
 
+  useEffect(() => {
+    if (autoFocusEnd && textRef.current && textareaWarp) {
+      textRef.current.focus();
+      const length = textRef.current.value.length;
+      textRef.current.setSelectionRange(length, length);
+      setTimeout(() => {
+        if (textareaWarp) {
+          textareaWarp.scrollTop = textareaWarp.scrollHeight;
+        }
+        if (textRef.current) {
+          textRef.current.scrollTop = textRef.current.scrollHeight;
+        }
+      }, 0);
+    }
+  }, [textareaWarp]);
+
   const onKeyDown = (e: KeyboardEvent | React.KeyboardEvent<HTMLTextAreaElement>) => {
     handleKeyDown(e, tabSize, defaultTabEnable);
     shortcuts(e, [...(commands || []), ...(extraCommands || [])], executeRef.current, dispatch, statesRef.current);

package/src/index.tsx

@@ -3,6 +3,7 @@ import * as commands from './commands/';
 import * as MarkdownUtil from './utils/markdownUtils';
 import './index.less';
 
+export { headingExecute } from './commands/title';
 export * from './commands/';
 export * from './commands/group';
 export * from './utils/markdownUtils';