realmail-editor
TypeScript icon, indicating that this package has built-in type declarations

0.15.2 • Public • Published

realmail-editor

Introduction

Email render and preview container.

usage

$ npm install --save realmail-editor

or

$ yarn add realmail-editor
import React from "react";
import { BlockManager } from "realmail-core";
import { EmailEditor, EmailEditorProvider } from "realmail-editor";
import "realmail-editor/lib/style.css";

const initialValues = {
  subject: "Welcome to realmail",
  subTitle: "Nice to meet you!",
  content: BlockManager.getBlockByType(BasicType.PAGE).create({}),
};

export function App() {
  return (
    <EmailEditorProvider data={initialValues} height={"calc(100vh - 72px)"}>
      {({ values }) => {
        return <EmailEditor />;
      }}
    </EmailEditorProvider>
  );
}

customize

If you customize the UI yourself,maybe you need to know

  • hooks

    • useActiveTab // current tab is edit or preview
    • useBlock // includes addBlock、moveBlock、removeBlock、undo, redo, etc.
    • useHoverIdx // hover block related, dragging status related, dragging direction related
    • useEditorProps // get props from EmailEditorProvider
    • useEditorContext // get form state and initialized status
    • useFocusIdx // focus block related
  • utils (These are some very simple methods, it is best to look at the implementation)

    • getBlockNodeByIdx
    • getBlockNodes
    • getShadowRoot
    • scrollBlockEleIntoView
  • components

    • BlockAvatarWrapper // allow drag and drop to editor

Readme

Keywords

Package Sidebar

Install

Weekly Downloads

0

Version

0.15.2

License

MIT

Unpacked Size

1.98 MB

Total Files

88

Last publish

Collaborators

  • m-ryan