@mihirpaldhikar/polaris

v0.8.2

Published

a year ago

A rich semantic content editor.

Downloads

474

0High
0Medium
0Low

mihirpaldhikar

Content Editor Text Editor Markdown React Editor

Polaris

https://github.com/mihirpaldhikar/polaris/assets/68847718/ebf91959-646c-4f6f-b19f-709dc794394a

Polaris is a rich semantic content editor built on top of React and Web APIs to create a rich content editing experience.

The editing interface is created by creating an abstraction layer on the top of Browser.

Instead of letting browser manage the DOM tree, Polaris acts as a middleware and intercepts the browser emitted events then perform operations over it and then instructs browser to re-render only updated nodes of the DOM tree.

Polaris uses Virtual DOM to efficiently update, and manage the DOM tree.

Features

[x] Title, SubTitle, Heading, Subheading, Paragraphs and Blockquotes.
[x] Changing one block to another on the fly with slash (/) command.
[x] Markdown Support
[x] Inline Styling
[x] Inline Links
[x] Image
[x] Lists
[x] Embeds (YouTube Video, GitHub Gist)
[x] Tables

Installation

npm install @mihirpaldhikar/polaris

Usage

Creating an Editor

import { Editor, generateUUID } from "@mihirpaldhikar/polaris";

export default function MyApp(): JSX.Element {
  const blob: Blob = {
    id: "MB1624",
    name: "Polaris Doc",
    description: "A basic Polaris Document",
    author: "Mihir Paldhikar",
    blocks: [
      {
        id: generateUUID(),
        role: "title",
        data: "Introducing Polaris",
        style: [],
      },
      {
        id: generateUUID(),
        role: "paragraph",
        data: "Polaris is a rich semantic content editor.",
        style: [],
      },
    ],
  };

  function attachmentHandler(data: File | string): string {
    /**
     * Logic to handle image.
     * must return a url.
     */
    return fileURL;
  }

  return (
    <Fragment>
      <Editor
        blob={blob}
        onAttachmentSelected={(data) => {
          return attachmentHandler(data);
        }}
      />
    </Fragment>
  );
}

Exporting Generated Blob to HTML

import { generateUUID, serializeBlob } from "@mihirpaldhikar/polaris";

const blob: Blob = {
  id: "MB1624",
  name: "Polaris Doc",
  description: "A basic Polaris Document",
  author: "Mihir Paldhikar",
  blocks: [
    {
      id: generateUUID(),
      role: "title",
      data: "Introducing Polaris",
      style: [],
    },
    {
      id: generateUUID(),
      role: "paragraph",
      data: "Polaris is a rich semantic content editor.",
      style: [],
    },
  ],
};

function exportBlobToHTML(blob) {
  console.log(serializeBlob(blob));
}

Output

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta
      name="viewport"
      content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
    />
    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
    <meta name="description" content="A basic Polaris Document" />
    <meta name="author" content="Mihir Paldhikar" />
    <title>Polaris Doc</title>
  </head>
  <body>
    <h1 id="4da4d82a-4efc-45ac-bfdf-d78a06a392f6">Introducing Polaris</h1>
    <p id="9b74c5a2-0807-4eaf-a1bd-33ea5ea74557">
      Polaris is a rich semantic content editor.
    </p>
    <script type="text/javascript">
      window.onmessage = function (messageEvent) {
        const height = messageEvent.data.height;
        const gistFrame = document.getElementById(messageEvent.data.id);
        if (gistFrame != null) {
          gistFrame.style.height = height + "px";
        }
      };
    </script>
  </body>
</html>

Configuring The Editor

The Text Size, Line Height, Spacing in Lists and Attachments can be configured using PolarisConfig which is passed as config property to the Editor. For all the values, the default unit is in rem.

Default Config:

const DEFAULT_POLARIS_CONFIG: PolarisConfig = {
  block: {
    text: {
      title: {
        fontSize: 2.25,
        fontWeight: 800,
        lineHeight: 2.3,
      },
      subTitle: {
        fontSize: 1.875,
        fontWeight: 700,
        lineHeight: 2,
      },
      heading: {
        fontSize: 1.5,
        fontWeight: 600,
        lineHeight: 1.9,
      },
      subHeading: {
        fontSize: 1.25,
        fontWeight: 500,
        lineHeight: 1.8,
      },
      paragraph: {
        fontSize: 1,
        fontWeight: 400,
        lineHeight: 1.75,
      },
      quote: {
        fontSize: 1,
        fontWeight: 500,
        lineHeight: 1.75,
      },
    },
    attachment: {
      spacing: 1,
    },
    list: {
      spacing: 1,
    },
  },
};

Important Notes:

If you are using React 18 & above or frameworks like Next.js, you need to explicitly specify the page or component consuming the Polaris Editor as a client component.
Serialization from Blob to HTML only works on the Client Side as it uses DOM behind the scene to convert Blob to corresponding HTML.

Upcoming Features

[ ] Code

Terminologies

block - A BlockSchema is the smallest unit holding all the necessary information required to render blocks.
blob - A Blob is a collection of blocks holding all the information and position of the blocks.
composer - A Composer uses block to determine how to render blocks.
editor - An Editor is an orchestrator for all the blocks. It uses blob to handle the creation, update, deletion of the blocks.

BlockSchema Roles

title - To render text as a Title
subTitle - To render text as a SubTitle
heading - To render text as a Heading
subHeading - To render text as a SubHeading
paragraph - To render text as a Paragraph
quote - To render content as quote
bulletList - To render bullet list
numberedList - To render numbered list
image - To render blocks an image
youtubeVideoEmbed - To Embed YouTube Video.
githubGistEmbed - To Embed GitHub Gist.
table - To Add tabular content.