HighRise-RTE

Installation Steps ​

Welcome to the HighRise-RTE. Built with Vue3, this editor aims to provide the Rich-Text-Editor Experience.

Features ​

  • Extensions - A code snippet which adds a functionality to the editor
  • Controls - Are the triggers which invokes the extension usage. These triggers are generally Buttons & Dropdowns. You can build these from scratch or use the Controls provided with this package and leave all lifting to the provided control. The controls provided with having prefix RTEControl\*

Installation ​

Supports Vue > 3 apps Only

  1. Add the .npmrc file to the root of the consuming repository. Then add following keys for authentication, You can get _token-id_ from the Team lead or fellow developers.
bash
@gohighlevel:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=_token-id_
  1. Now install the following packages
bash
yarn add @platform-ui/rte

  1. Create the editor instance and pass it. RequiredExtensions is mandatory to make the editor work. This should be wrapped inside the HLContentWrap component.

    • Import the HLContentWrap component from @platform-ui/highrise
    • We recommend to use @platform-ui/highrise of version >= 2
ts
import { RequiredExtensions, Editor, HLTextEditor } from '@platform-ui/rte'
const editorInstance = new Editor({
  extensions: [RequiredExtensions],
})
html
<template>
  <HLTextEditor :editor="editorInstance" />
</template>