fix: rename title to heading for clarity and consistency. #693

Author: jaywcjlove

core/commands.d.ts

@@ -14,13 +14,13 @@ declare module '@uiw/react-md-editor/commands' {
   import { codeEdit, codeLive, codePreview } from '@uiw/react-md-editor/esm/commands/preview';
   import { quote } from '@uiw/react-md-editor/esm/commands/quote';
   import { strikethrough } from '@uiw/react-md-editor/esm/commands/strikeThrough';
-  import { title } from '@uiw/react-md-editor/esm/commands/title';
-  import { title1 } from '@uiw/react-md-editor/esm/commands/title1';
-  import { title2 } from '@uiw/react-md-editor/esm/commands/title2';
-  import { title3 } from '@uiw/react-md-editor/esm/commands/title3';
-  import { title4 } from '@uiw/react-md-editor/esm/commands/title4';
-  import { title5 } from '@uiw/react-md-editor/esm/commands/title5';
-  import { title6 } from '@uiw/react-md-editor/esm/commands/title6';
+  import { title, heading } from '@uiw/react-md-editor/esm/commands/title';
+  import { title1, heading1 } from '@uiw/react-md-editor/esm/commands/title1';
+  import { title2, heading2 } from '@uiw/react-md-editor/esm/commands/title2';
+  import { title3, heading3 } from '@uiw/react-md-editor/esm/commands/title3';
+  import { title4, heading4 } from '@uiw/react-md-editor/esm/commands/title4';
+  import { title5, heading5 } from '@uiw/react-md-editor/esm/commands/title5';
+  import { title6, heading6 } from '@uiw/react-md-editor/esm/commands/title6';
   import { table } from '@uiw/react-md-editor/esm/commands/table';
   import { issue } from '@uiw/react-md-editor/esm/commands/issue';
   import { help } from '@uiw/react-md-editor/esm/commands/help';
@@ -117,6 +117,13 @@ declare module '@uiw/react-md-editor/commands' {
     title4,
     title5,
     title6,
+    heading,
+    heading1,
+    heading2,
+    heading3,
+    heading4,
+    heading5,
+    heading6,
     bold,
     codeBlock,
     comment,

core/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;
 }

core/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,

core/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;

core/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 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;

core/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 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;

core/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 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;

core/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 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;

core/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 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;

core/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 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;