feat: add showToolbar props. #221

uiwjs · Apr 21, 2024 · 01d5559 · 01d5559
1 parent 6fe4514
commit 01d5559
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/core/README.md b/core/README.md
@@ -288,8 +288,10 @@ export interface IMarkdownEditor extends ReactCodeMirrorProps {
   toolbarsFilter?: (tool: Commands, idx: number) => boolean;
   /** Toolbar on bottom */
   toolbarBottom?: boolean;
-  /** Option to hide the tool bar. */
+  /** Option to hide the tool bar. @deprecated The next major version will be deprecated. Please use `showToolbar`. */
   hideToolbar?: boolean;
+  /** Option to hide the tool bar. */
+  showToolbar?: boolean;
   /** [@uiw/react-markdown-preview](https://github.com/uiwjs/react-markdown-preview#options-props) options */
   previewProps?: MarkdownPreviewProps;
   /** replace the default `extensions` */

diff --git a/core/src/index.tsx b/core/src/index.tsx
@@ -45,8 +45,10 @@ export interface IMarkdownEditor extends ReactCodeMirrorProps {
   toolbarsFilter?: (tool: Commands, idx: number) => boolean;
   /** Toolbar on bottom */
   toolbarBottom?: boolean;
-  /** Option to hide the tool bar. */
+  /** Option to hide the tool bar. @deprecated The next major version will be deprecated. Please use `showToolbar`. */
   hideToolbar?: boolean;
+  /** Option to hide the tool bar. */
+  showToolbar?: boolean;
   /** [@uiw/react-markdown-preview](https://github.com/uiwjs/react-markdown-preview#options-props) options */
   previewProps?: MarkdownPreviewProps;
   /** replace the default `extensions` */
@@ -95,7 +97,8 @@ function MarkdownEditorInternal(
     visible = true,
     renderPreview,
     visibleEditor = true,
-    hideToolbar = true,
+    hideToolbar,
+    showToolbar = true,
     toolbarBottom = false,
     enableScroll = true,
     enablePreview = true,
@@ -222,7 +225,8 @@ function MarkdownEditorInternal(
 
   const tools = toolbarsFilter ? toolbars.filter(toolbarsFilter) : toolbars;
   const toolsMode = toolbarsFilter ? toolbarsMode.filter(toolbarsFilter) : toolbarsMode;
-  const toolbarView = hideToolbar && (
+  const isShowToolbar = hideToolbar ?? showToolbar;
+  const toolbarView = isShowToolbar && (
     <div className={clsToolbar}>
       <ToolBar {...toolBarProps} toolbars={tools} />
       <ToolBar {...toolBarProps} toolbars={toolsMode} mode />

diff --git a/www/src/Example.tsx b/www/src/Example.tsx
@@ -23,7 +23,7 @@ export function ExampleDemo() {
         height="500px"
         value={mdstr}
         enableScroll={enableScroll}
-        hideToolbar={hideToolbar}
+        showToolbar={hideToolbar}
         toolbarBottom={toolbarBottom}
       />
       <div style={{ marginTop: 10, display: 'flex', gap: '10px' }}>
@@ -37,7 +37,7 @@ export function ExampleDemo() {
         </button>
         <label>
           <input type="checkbox" checked={hideToolbar} onChange={(evn) => setHideToolbar(evn.target.checked)} />
-          hideToolbar
+          showToolbar
         </label>
         <label>
           <input type="checkbox" checked={enableScroll} onChange={(evn) => setEnableScroll(evn.target.checked)} />