Add an AI Text Editor to the Remix Supabase SaaS Starter kit

NB: this is currently a work in progress and not yet available.

A Text Editor built with Lexical.

Installation

Pull the plugin from the main repository:

npx @makerkit/cli@latest plugins install text-editor

Now, install the plugin from your main app by adding the following to your package.json file:

{
 "dependencies": {
   "@kit/text-editor": "workspace:*"
 }
}

And then run pnpm install to install the plugin.

AI Routes

Add the following AI Routes to your Remix API routes:

One route at apps/web/app/routes/api.editor.edit._index/route.ts:

import { ActionFunctionArgs } from '@remix-run/server-runtime';
import { createAIEditRouteHandler } from '@kit/text-editor/server';
export const action = ({ request }: ActionFunctionArgs) => {
  return createAIEditRouteHandler(request);
};

And another route at apps/web/app/routes/api.editor.autocomplete._index/route.ts:

import { ActionFunctionArgs } from '@remix-run/server-runtime';
import { createAIAutocompleteRouteHandler } from '@kit/text-editor/server';
export const action = ({ request }: ActionFunctionArgs) => {
  return createAIAutocompleteRouteHandler(request);
};

Environment Variables

Make sure to add the variable OPENAI_API_KEY to your .env.local file to test locally, and make sure it's added to your production environment variables.

Import the component

Now, you can import the component from the plugin:

import { TextEditor } from '@kit/text-editor';
import '@kit/text-editor/style';

And use it in your app:

<TextEditor />

You can assign the following props to the TextEditor component:

{
  className?: string;
  content?: string;
  placeholder?: () => React.ReactElement;
  onChange?: (content: string) => void;
}