react-headless-mde 1.0.3 → 2.0.0

package/README.md

@@ -12,14 +12,26 @@ React-mde-headless has no 3rd party dependencies.
 ## Using
 
 ```jsx
-import { bold, italic, link, useTextAreaMarkdownEditor } from 'react-mde-headless';
+import { boldCommand, italicCommand, linkCommand, useTextAreaMarkdownEditor } from 'react-mde-headless';
 
 export const MarkdownEditor = () => {
-  const { ref } = useTextAreaMarkdownEditor();
+  const { ref, commandController } = useTextAreaMarkdownEditor({
+    commandMap: {
+      bold: boldCommand,
+      italic: italicCommand,
+      link: linkCommand,
+    },
+  });
 
   return (
     <div>
-      <button onClick={bold}>B</button>
+      <button
+        onClick={() => {
+          commandController.executeCommand('bold');
+        }}
+      >
+        B
+      </button>
 
       <textarea ref={ref} />
     </div>
@@ -29,24 +41,23 @@ export const MarkdownEditor = () => {
 
 ## Supported commands
 
-- bold
-- italic
-- strikethrough
 - headingLevel1
 - headingLevel2
 - headingLevel3
 - headingLevel4
 - headingLevel5
 - headingLevel6
-- link
 - quote
-- code
-- codeBlock
 - checkedList
 - orderedList
 - unorderedList
+- bold
+- code
+- codeBlock
+- italic
+- strikethrough
 - image
-- attachment
+- link
 
 ## Todo
 
@@ -54,6 +65,16 @@ export const MarkdownEditor = () => {
 - undo/redo
 - Check execution on SSR (For example, Next.js) and, if necessary, regenerate eslint config, taking into account execution on node.js
 - peerDependencies React?
+- undo for
+  - 1st priority
+    - all headings
+    - quote
+    - strikethrough
+  - 2nd priority
+    - orderedList
+    - unorderedList
+    - checkedList
+    - codeBlock
 
 PR's are welcome!
 
@@ -69,7 +90,7 @@ this has been taken from [their documentation](<https://github.com/showdownjs/sh
 > Cross-side scripting is a well known technique to gain access to private information of the users
 > of a website. The attacker injects spurious HTML content (a script) on the web page which will read
 > the user’s cookies and do something bad with it (like steal credentials). As a countermeasure,
-> you should filter any suspicious content coming from user input. Showdown doesn’t include an
+> you should filter any suspicious content coming from user input. Showdown does not include an
 > XSS filter, so you must provide your own. But be careful in how you do it…
 
 You might want to take a look at [showdown-xss-filter](https://github.com/VisionistInc/showdown-xss-filter).