Veridical

Veridical is a set of lexical plugins and nodes that can be used to make a WYSIWYG (What You See Is What You Get) Editor.
Check out veridical at https://panditraghav.github.io/veridical

Features

- CommandMenuPluign - Build notion like command menu
- SlashCommandMenuPlugin - Open command menu by typing '/'
- FloatingActionMenuPlugin - Floating action menu for selected text
- LinkPopoverPlugin - Popover to add links
- CaretLinkPopoverPlugin - Opens popover when caret is on a LinkNode
- HoveredNodeOptionsPlugin - Shows node options (Add, Drag) on left side of hovered node.
- PrettierPlugin - Formats code (on pressing Alt+Shift+F by default)

Upcoming features

- Image Support
- Table Support

Basic Editor Setup

``tsx
import { LexicalComposer } from '@lexical/react/LexicalComposer';

import {
CodeHighlightPlugin,
defaultEditorNodes,
ImagePlugin,
MarkdownPlugin,
PrettierPlugin,
RegisterVeridicalCommands,
} from 'veridical';

import { AutoFocusPlugin } from '@lexical/react/LexicalAutoFocusPlugin';
import { ContentEditable } from '@lexical/react/LexicalContentEditable';
import { HistoryPlugin } from '@lexical/react/LexicalHistoryPlugin';
import { ListPlugin } from '@lexical/react/LexicalListPlugin';
import { RichTextPlugin } from '@lexical/react/LexicalRichTextPlugin';
import { TabIndentationPlugin } from '@lexical/react/LexicalTabIndentationPlugin';

import CommandMenuPlugin from '../plugins/CommandMenu';

export default function Editor() {
return (
initialConfig={{
namespace: 'playground',
theme: lexicalTheme,
nodes: defaultEditorNodes,
editable: true,
onError: (error: any) => console.log(error),
//editorState: editorState || initializeEditor,
}}
>

contentEditable={

}
placeholder={

Press / for commands

}
ErrorBoundary={YourErrorBoundary}
/>

);
}
`

Plugins

See lexical plugins for more information.

$3

The command menu plugin is built using cmdk and @radix-ui/popover.

#### Usage

`tsx
import 'style.css'; // Your own styles
import {
CommandMenuPlugin as CommandMenu,
SlashCommandMenuPlugin,
} from 'veridical/plugins';

import {
INSERT_HEADING_COMMAND,
INSERT_CODE_COMMAND,
INSERT_LIST_COMMAND,
INSERT_PARAGRAPH_COMMAND,
INSERT_QUOTE_COMMAND,
} from 'veridical/commands';

import { LexicalEditor } from 'lexical';
import { useLexicalComposerContext } from '@lexical/react/LexicalComposerContext';

export default function CommandMenuPlugin() {
return (
<>





No result








);
}

export function LargeCommandItem({
name,
description,
icon,
onSelect,
}: LargeCommandItemType) {
const [editor] = useLexicalComposerContext();
return (
value={name + ' ' + description}
onSelect={(value) => {
onSelect(editor, value);
}}
className="LargeCommandItem"
>

{icon}

{name}

{description}

);
}

function InsertCommands() {
return (

{INSERT_COMMAND_ITEMS.map((item) => {
return ;
})}

);
}

const INSERT_COMMAND_ITEMS: LargeCommandItemType[] = [
{
name: 'Heading 1',
description: 'Title level heading',
icon:

,
onSelect: (editor) =>
editor.dispatchCommand(INSERT_HEADING_COMMAND, {
headingTag: 'h1',
}),
},
{
name: 'Heading 2',
description: 'Second level heading',
icon:

,
onSelect: (editor) =>
editor.dispatchCommand(INSERT_HEADING_COMMAND, {
headingTag: 'h2',
}),
},
];
`

Veridical Commands

You can dispatch any commands using editor.dispatchCommand() which you can get from useLexicalComposerContext().
Checkout lexical commands for more information

`tsx
import { INSERT_HEADING_COMMAND } from 'veridical/commands';

function YourComponentInsideLexicalComposer() {
const [editor] = useLexicalComposerContext();
return (

onClick={(ev) =>
editor.dispatchCommand(INSERT_HEADING_COMMAND, {
headingTag: 'h1',
})
}
>
Some Component

);
}
`

$3

- INSERT_HEADING_COMMAND
- INSERT_PARAGRAPH_COMMAND
- INSERT_CODE_COMMAND
- INSERT_LIST_COMMAND
- INSERT_QUOTE_COMMAND

$3

- TURN_INTO_HEADING_COMMAND
- TURN_INTO_LIST_COMMAND
- TURN_INTO_PARAGRAPH_COMMAND
- TURN_INTO_QUOTE_COMMAND

$3

- MOVE_SELECTED_NODE_COMMAND

$3

- OPEN_COMMAND_MENU

$3

- LINK_POPOVER_COMMAND

Goal of project

The goal of the project is a editor which can be installed as npm` package and is easy to integrate into your react project. It must be customizable and have a composable API.

hernamina