react-headless-mde 2.0.2 → 3.0.0-beta1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vitaliy Komarov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -12,14 +12,14 @@ React-mde-headless has **no 3rd party dependencies**.
 ## Using
 
 ```jsx
-import { boldCommand, italicCommand, linkCommand, useTextAreaMarkdownEditor } from 'react-headless-mde';
+import { BoldCommand, ItalicCommand, LinkCommand, useTextAreaMarkdownEditor } from 'react-headless-mde';
 
 export const MarkdownEditor = () => {
-  const { ref, commandController } = useTextAreaMarkdownEditor({
+  const { ref, commands } = useTextAreaMarkdownEditor({
     commandMap: {
-      bold: boldCommand,
-      italic: italicCommand,
-      link: linkCommand,
+      bold: BoldCommand,
+      italic: ItalicCommand,
+      link: LinkCommand,
     },
   });
 
@@ -27,7 +27,7 @@ export const MarkdownEditor = () => {
     <div>
       <button
         onClick={() => {
-          commandController.executeCommand('bold');
+          commands.bold();
         }}
       >
         B
@@ -39,6 +39,47 @@ export const MarkdownEditor = () => {
 };
 ```
 
+## Custom commands
+
+A command is a class extending `BaseCommand`. The hook instantiates it with the editor's
+`TextController` and returns a typed executor. If a command needs a context
+(e.g. an `attachment` command accepting an upload promise), extend `BaseCommand<Context>`
+— the executor then requires the context argument:
+
+```tsx
+import { BaseCommand, useTextAreaMarkdownEditor } from 'react-headless-mde';
+
+class AttachmentCommand extends BaseCommand<Promise<string>> {
+  async do(upload: Promise<string>) {
+    const url = await upload;
+    this.textController.replaceSelection(`![](${url})`);
+  }
+}
+
+export const MarkdownEditor = () => {
+  const { ref, commands } = useTextAreaMarkdownEditor({
+    commandMap: {
+      attachment: AttachmentCommand,
+      bold: BoldCommand,
+    },
+  });
+
+  commands.attachment(uploadPromise); // OK
+  commands.attachment(); // Type error: 1 argument expected
+  commands.bold(42); // Type error: 0 arguments expected
+
+  // ...
+};
+```
+
+Working examples of commands with a context live in
+[demo/attachment-command.ts](demo/attachment-command.ts) (`Promise<string>` context)
+and [demo/wrap-text-command.ts](demo/wrap-text-command.ts) (a simple `string` context,
+wraps the word at the caret with it on both sides), wired up in `demo/index.tsx`.
+
+For undoable commands implement `shouldUndo`/`undo` — the command is then toggled:
+executing it on already formatted text removes the formatting (see `WrapCommand`).
+
 ## Supported commands
 
 - headingLevel1
@@ -59,22 +100,23 @@ export const MarkdownEditor = () => {
 - image
 - link
 
+## Command API
+
+Since v3 commands are classes (see [issue #22](https://github.com/Webbrother/react-headless-mde/issues/22)):
+the `commandMap` maps camelCase command names to command classes, and the hook returns
+strictly typed `commands` executors. The pre-v3 object-based API
+(`commandController.executeCommand('bold')`) was removed.
+
 ## Todo
 
-- heading undo
-- undo/redo
+- Redo commands
 - 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
+- Undo for
   - 2nd priority
-    - orderedList
-    - unorderedList
-    - checkedList
-    - codeBlock
+    - `orderedList`
+    - `unorderedList`
+    - `checkedList`
+    - `codeBlock`
 
 PR's are welcome!
 
@@ -93,12 +135,11 @@ this has been taken from [their documentation](<https://github.com/showdownjs/sh
 > 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).
-
-## Licence
+You might want to take a look at
 
-React-mde-headless is [MIT licensed](https://github.com/andrerpena/react-mde/blob/master/LICENSE).
+- [rehype-sanitize](https://github.com/rehypejs/rehype-sanitize).
+- [showdown-xss-filter](https://github.com/VisionistInc/showdown-xss-filter).
 
 ## About the authors
 
-Created by [André Pena](https://github.com/andrerpena). Maintained and developed by https://github.com/webbrother.
+The idea from [André Pena](https://github.com/andrerpena). Maintained and developed by Vitaliy Komarov https://github.com/webbrother.