npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-konva-rich-text-editor

v1.1.5

Published

React Konva WYSIWYG rich text editor

Downloads

343

Readme

React Konva Rich Text Editor

A rich-text editor for React Konva, providing seamless integration of text editing capabilities on a canvas. This library allows you to manipulate text on a canvas, similar to tools like Microsoft Word, but within the powerful canvas rendering context provided by React-Konva.

Table of Contents

Installation

npm install react-konva-rich-text-editor

or

yarn add react-konva-rich-text-editor

Features

  • Rich Text Editing: Leverage the power of TipTap to provide rich-text editing capabilities.
  • Canvas Integration: Seamlessly integrate text editing within a React Konva canvas.
  • Flexible Editors: Choose between Inline, Internal, or External editors to suit your application's needs.
  • Customizable: Easily customize editor styles, toolbar options, and more.

Components

This library provides six main components:

Editors

  1. InlineEditor: Appears inline when you double-click the text image on the canvas, giving the illusion of editing the text directly.
  2. InternalEditor: Pops up over the canvas when you double-click the text image.
  3. ExternalEditor: Always visible and edits the text image from outside the canvas.

Images

Corresponding to each editor, there is an image component:

  1. Image.Inline: Renders the text as an image on the canvas and interacts with the InlineEditor.
  2. Image.Internal: Works with the InternalEditor.
  3. Image.External: Works with the ExternalEditor.

Usage

Inline Editor Example

View the Inline Editor example on StackBlitz

import { useState } from 'react';
import Image, { InlineEditor } from 'react-konva-rich-text-editor';
import type { InlineEditorEl } from 'react-konva-rich-text-editor';
import { Stage, Layer } from 'react-konva';
import Konva from 'konva';

function App() {
  const [editorEl, setEditorEl] = useState<InlineEditorEl>({
    x: 110,
    y: 110,
    width: 720,
    height: 360,
    open: false, // Required for InlineEditor
    fontSize: 66,
  });
  const [svgImage, setSvgImage] = useState('');

  const handleDragEnd = (e: Konva.KonvaEventObject<DragEvent>) => {
    const { x, y } = e.target.position();
    setEditorEl((prev) => ({
      ...prev,
      x,
      y,
    }));
  };

  return (
    <>
      <Stage width={window.innerWidth} height={window.innerHeight}>
        <Layer>
          <Image.Inline
            svgImage={svgImage}
            setEditorEl={setEditorEl}
            editorEl={editorEl}
            x={editorEl.x}
            y={editorEl.y}
            draggable
            onDragEnd={handleDragEnd}
          />
        </Layer>
      </Stage>
      <InlineEditor
        initialText="Hello, world!"
        setSvgImage={setSvgImage}
        setEditorEl={setEditorEl}
        editorEl={editorEl}
        editorStyle={{}}
      />
    </>
  );
}

export default App;

Internal Editor Example

View the Internal Editor example on StackBlitz

import { useState } from 'react';
import Image, { InternalEditor } from 'react-konva-rich-text-editor';
import type { InternalEditorEl } from 'react-konva-rich-text-editor';
import { Stage, Layer } from 'react-konva';
import Konva from 'konva';

function App() {
  const [editorEl, setEditorEl] = useState<InternalEditorEl>({
    x: 100,
    y: 100,
    width: 600,
    height: 300,
    open: false, // Required for InternalEditor
    fontSize: 48,
  });
  const [svgImage, setSvgImage] = useState('');

  const handleDragEnd = (e: Konva.KonvaEventObject<DragEvent>) => {
    const { x, y } = e.target.position();
    setEditorEl((prev) => ({
      ...prev,
      x,
      y,
    }));
  };

  return (
    <>
      <Stage width={window.innerWidth} height={window.innerHeight}>
        <Layer>
          <Image.Internal
            svgImage={svgImage}
            setEditorEl={setEditorEl}
            editorEl={editorEl}
            x={editorEl.x}
            y={editorEl.y}
            draggable
            onDragEnd={handleDragEnd}
          />
        </Layer>
      </Stage>
      <InternalEditor
        initialText="Edit me!"
        setSvgImage={setSvgImage}
        setEditorEl={setEditorEl}
        editorEl={editorEl}
        editorStyle={{}}
      />
    </>
  );
}

export default App;

External Editor Example

View the External Editor example on StackBlitz

import { useState } from 'react';
import Image, { ExternalEditor } from 'react-konva-rich-text-editor';
import type { ExternalEditorEl } from 'react-konva-rich-text-editor';
import { Stage, Layer } from 'react-konva';

function App() {
  const [editorEl, setEditorEl] = useState<ExternalEditorEl>({
    x: 50,
    y: 50,
    width: 500,
    height: 250,
    fontSize: 36,
  });
  const [svgImage, setSvgImage] = useState('');

  return (
    <>
      <Stage width={window.innerWidth} height={window.innerHeight}>
        <Layer>
          <Image.External
            svgImage={svgImage}
            x={editorEl.x}
            y={editorEl.y}
            draggable
          />
        </Layer>
      </Stage>
      <ExternalEditor
        initialText="Always editable"
        setSvgImage={setSvgImage}
        editorEl={editorEl}
        editorStyle={{}}
      />
    </>
  );
}

export default App;

API Reference

Editors

InlineEditor

  • Description: An editor that appears inline when you double-click the corresponding image on the canvas.
  • Props:
    • initialText (string): The initial text content.
    • editorEl (InlineEditorEl): Editor state object.
    • setEditorEl (function): State updater for editorEl.
    • setSvgImage (function): Function to update the SVG image.
    • editorStyle (object): Custom styles for the editor.
    • toolbarOptions (array): Customize toolbar options.

InternalEditor

  • Description: An editor that pops up over the canvas when you double-click the corresponding image.
  • Props: Same as InlineEditor.

ExternalEditor

  • Description: An editor that is always visible and edits the text image from outside the canvas.
  • Props:
    • initialText (string): The initial text content.
    • editorEl (ExternalEditorEl): Editor state object.
    • setSvgImage (function): Function to update the SVG image.
    • editorStyle (object): Custom styles for the editor.
    • toolbarOptions (array): Customize toolbar options.

Images

Image.Inline

  • Description: Corresponds to InlineEditor. Renders the text as an image on the canvas.
  • Props:
    • svgImage (string): The SVG image source.
    • editorEl (InlineEditorEl): Editor state object.
    • setEditorEl (function): State updater for editorEl.
    • x, y (number): Position on the canvas.
    • Additional Konva Image props.

Image.Internal

  • Description: Corresponds to InternalEditor.
  • Props: Same as Image.Inline.

Image.External

  • Description: Corresponds to ExternalEditor.
  • Props:
    • svgImage (string): The SVG image source.
    • x, y (number): Position on the canvas.
    • Additional Konva Image props.

Types

InlineEditorEl & InternalEditorEl

  • Properties:
    • x, y (number): Position on the canvas.
    • width, height (number): Dimensions of the editor.
    • open (boolean): Controls the visibility of the editor.
    • fontSize (number, optional): Font size for the text.

ExternalEditorEl

  • Properties:
    • x, y (number): Position on the canvas.
    • width, height (number): Dimensions of the editor.
    • fontSize (number, optional): Font size for the text.

Feel free to contribute to this project by submitting issues or pull requests on GitHub.