Skip to content

README.md

Latest commit

 

History

History
92 lines (62 loc) · 2.79 KB

README.md

File metadata and controls

92 lines (62 loc) · 2.79 KB
Raw

@arkpad/react

React components and hooks for the Arkpad rich text editor.

📦 Installation

npm install @arkpad/react @arkpad/core

🚀 Quick Start

import { useArkpadEditor, ArkpadEditorContent } from "@arkpad/react";
import { Essentials } from "@arkpad/core";

const MyEditor = () => {
  const editor = useArkpadEditor({
    extensions: [Essentials],
    content: "<p>Built with Arkpad React</p>",
  });

  return <ArkpadEditorContent editor={editor} />;
};

🛠 Hooks & Components

useArkpadEditor(options)

A hook that creates and manages an ArkpadEditor instance. It automatically handles cleanup on unmount.

ArkpadEditorContent

The component that renders the editor surface.

  • editor: The editor instance from useArkpadEditor.
  • className: Optional CSS class for the container.

🎨 Building a Toolbar

Arkpad is headless, meaning you provide the UI. Here is how to build a toolbar matching the Ultimate Arkpad UI:

import { useArkpadEditor } from "@arkpad/react";

const Toolbar = ({ editor }) => {
  if (!editor) return null;

  const Button = ({ command, icon, activeName, activeAttrs }) => (
    <button
      onClick={() => editor.commands[command]()}
      className={editor.isActive(activeName || command, activeAttrs) ? "is-active" : ""}
    >
      {icon}
    </button>
  );

  return (
    <div className="toolbar">
      <Button command="toggleBold" activeName="strong" icon="B" />
      <Button command="toggleItalic" activeName="em" icon="I" />
      <Button command="toggleUnderline" activeName="underline" icon="U" />

      <div className="divider" />

      <Button command="toggleHeading" activeAttrs={{ level: 1 }} icon="H1" />

      <Button command="toggleHighlighter" activeName="highlighter" icon="🖍" />

      <button onClick={() => editor.commands.undo()}>Undo</button>
      <button onClick={() => editor.commands.redo()}>Redo</button>
    </div>
  );
};

💡 Pro Tip: Reactive State

useArkpadEditor returns a reactive editor instance. Your UI will automatically re-render whenever the selection or content changes, making it trivial to keep toolbar states in sync.

🚀 Versioning & Release Flow

Arkpad uses an automated, conventional-commit-driven release workflow:

  • Automatic Version Bumps: Any code changes in @arkpad/react trigger package version updates and generate changesets automatically on merge to main.
  • Beautiful Emojified Changelogs: Changes are grouped into clean categories like ✨ Features, 🐛 Bug Fixes, ⚡ Performance Improvements, 📝 Documentation, ♻️ Refactoring, 🎨 Styles & UI, and 📦 Others.
  • GitHub Releases: Releases are automatically published on GitHub with the release description matching the version changelog exactly.

Built by ArkCabin