index int64 0 0 | repo_id stringlengths 16 181 | file_path stringlengths 28 270 | content stringlengths 1 11.6M | __index_level_0__ int64 0 10k |
|---|---|---|---|---|
0 | petrpan-code/udecode/plate/apps/e2e-examples | petrpan-code/udecode/plate/apps/e2e-examples/src/main.tsx | import React from 'react';
import ReactDOM from 'react-dom';
import { createBrowserRouter, RouterProvider } from 'react-router-dom';
import { TableApp } from './TableApp';
const router = createBrowserRouter([
{
path: '/table/:variant',
element: <TableApp />,
},
]);
const rootElement = document.querySelec... | 8,400 |
0 | petrpan-code/udecode/plate/apps/e2e-examples | petrpan-code/udecode/plate/apps/e2e-examples/src/useVariant.ts | import { useParams } from 'react-router-dom';
export const useVariant = <T>(variants: { [key: string]: T }) => {
const { variant } = useParams<{ variant: string }>();
const activeVariant = variants[variant!];
if (!activeVariant) {
throw new Error(
`Invalid variant: ${variant}. Expected one of ${Object... | 8,401 |
0 | petrpan-code/udecode/plate/apps/e2e-examples | petrpan-code/udecode/plate/apps/e2e-examples/src/vite-env.d.ts | /// <reference types="vite/client" />
| 8,402 |
0 | petrpan-code/udecode/plate/apps | petrpan-code/udecode/plate/apps/www/.prettierignore | node_modules
.next
build
.contentlayer
src/pages/api/registry.json | 8,403 |
0 | petrpan-code/udecode/plate/apps | petrpan-code/udecode/plate/apps/www/LICENSE | The MIT License (MIT)
Copyright (c) Ziad Beyens, Dylan Schiemann, Joe Anderson, shadcn
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights... | 8,404 |
0 | petrpan-code/udecode/plate/apps | petrpan-code/udecode/plate/apps/www/README.md | # Documentation
This is the documentation for the Plate project.
## Usage
Anytime you make a change in the `registry` folder, run:
```bash
yarn build:registry
```
## License
[MIT](./LICENSE)
| 8,405 |
0 | petrpan-code/udecode/plate/apps | petrpan-code/udecode/plate/apps/www/contentlayer.config.js | import path from 'node:path';
import {
defineDocumentType,
defineNestedType,
makeSource,
} from 'contentlayer/source-files';
import rehypeAutolinkHeadings from 'rehype-autolink-headings';
import rehypePrettyCode from 'rehype-pretty-code';
import rehypeSlug from 'rehype-slug';
import { codeImport } from 'remark-co... | 8,406 |
0 | petrpan-code/udecode/plate/apps | petrpan-code/udecode/plate/apps/www/next-env.d.ts | /// <reference types="next" />
/// <reference types="next/image-types/global" />
/// <reference types="next/navigation-types/compat/navigation" />
// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
| 8,407 |
0 | petrpan-code/udecode/plate/apps | petrpan-code/udecode/plate/apps/www/next.config.mjs | // import { createContentlayerPlugin } from 'next-contentlayer';
const nextConfig = async (phase, { defaultConfig }) => {
/**
* @type {import('next').NextConfig}
*/
const config = {
// Enable React strict mode.
// https://nextjs.org/docs/api-reference/next.config.js/react-strict-mod
reactStrictMo... | 8,408 |
0 | petrpan-code/udecode/plate/apps | petrpan-code/udecode/plate/apps/www/package.json | {
"private": true,
"name": "www",
"version": "0.0.1",
"description": "A simple NextJS app with Plate",
"scripts": {
"prebuild": "yarn build:contentlayer",
"build": "yarn prebuild && yarn build:registry && next build",
"build:contentlayer": "contentlayer build",
"build:registry": "ts-node --esm... | 8,409 |
0 | petrpan-code/udecode/plate/apps | petrpan-code/udecode/plate/apps/www/postcss.config.cjs | module.exports = require('../../postcss.config.cjs');
| 8,410 |
0 | petrpan-code/udecode/plate/apps | petrpan-code/udecode/plate/apps/www/tailwind.config.cjs | const baseConfig = require('../../tailwind.config.cjs');
/** @type {import('tailwindcss').Config} */
module.exports = {
...baseConfig,
content: [
...baseConfig.content,
'src/content/**/*.mdx',
'src/registry/**/*.{ts,tsx}',
],
};
| 8,411 |
0 | petrpan-code/udecode/plate/apps | petrpan-code/udecode/plate/apps/www/tsconfig.json | {
"compilerOptions": {
"target": "es5",
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"strict": false,
"forceConsistentCasingInFileNames": true,
"noEmit": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "node",
"reso... | 8,412 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/accessing-editor.mdx | ---
title: Accessing the Editor
description: Getting a reference to the editor instance
---
To do most things with Plate, you'll need to access the **`editor`** instance at one point or another. The way you'll do this depends on the context in which you need to access the **`editor`**.
## From Inside a Plugin
Most o... | 8,413 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/alignment.mdx | ---
title: Alignment
description: Align your content to different positions.
docs:
- route: /docs/components/align-dropdown-menu
title: Align Dropdown Menu
---
<ComponentPreview name="playground-demo" id="align" />
<PackageInfo>
## Features
- Provides text alignment options: left, right, center, or justify.
... | 8,414 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/autoformat.mdx | ---
title: Autoformat
description: Apply formatting automatically using shortcodes.
docs:
- route: /docs/basic-elements
title: Basic Elements
- route: /docs/basic-marks
title: Basic Marks
- route: /docs/horizontal-rule
title: Horizontal Rule
- route: /docs/list
title: List
---
<ComponentPreview... | 8,415 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/basic-elements.mdx | ---
title: Basic Elements
description: Enhance your editor with essential formatting elements.
docs:
- route: /docs/components/blockquote-element
title: Block Quote Element
- route: /docs/components/code-block-element
title: Code Block Element
- route: /docs/components/code-line-element
title: Code Li... | 8,416 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/basic-marks.mdx | ---
title: Basic Marks
description: Set of essential text formatting options.
docs:
- route: /docs/components/mark-toolbar-button
title: Mark Toolbar Button
---
<ComponentPreview name="playground-demo" id="basicnodes" />
<PackageInfo>
## Features
- Includes commonly used text styling features: bold, italic, u... | 8,417 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/block-selection.mdx | ---
title: Block Selection
description: Select and manipulate entire text blocks.
---
<ComponentPreview name="playground-demo" id="blockselection" />
<PackageInfo>
## Features
- Select entire blocks, as opposed to individual words or characters.
- To select an entire block, mouse down outside the text area and then... | 8,418 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/caption.mdx | ---
title: Caption
description: Add captions to your blocks.
docs:
- route: /docs/components/draggable
title: Draggable
---
<ComponentPreview name="playground-demo" id="media" />
<PackageInfo>
## Features
- Arrow navigation should select caption within a block.
</PackageInfo>
## Installation
```bash
npm in... | 8,419 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/cloud.mdx | ---
title: Cloud
description: Upload images and attachments to the cloud.
docs:
- route: /docs/components/cloud
title: Cloud
---
<ComponentPreview name="cloud-demo" padding="md" />
<PackageInfo>
## Features
- Image and attachment uploads, automatic server-side image resizing, and more.
- Supports drag and dro... | 8,420 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/collaboration.mdx | ---
title: Collaboration
description: Collaborate with others in a single document.
---
<Callout className="my-4">
**Backend Development in Progress** - Demo Unavailable.
</Callout>
<PackageInfo>
## Features
- The yjs plugin enables support for collaboration using [slate-yjs](https://docs.slate-yjs.dev/) and [Hoc... | 8,421 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/combobox.mdx | ---
title: Combobox
description: Select options from a list of predefined values.
docs:
- route: /docs/components/combobox
title: Combobox
- route: /docs/components/emoji-combobox
title: Emoji Combobox
- route: /docs/components/mention-combobox
title: Mention Combobox
---
<PackageInfo>
## Features
... | 8,422 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/comments.mdx | ---
title: Comments
description: Add comments to text as marks.
docs:
- route: /docs/components/comment-leaf
title: Comment Leaf
- route: /docs/components/comment-toolbar-button
title: Comment Toolbar Button
- route: /docs/components/comments-popover
title: Comments Popover
---
<ComponentPreview name... | 8,423 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/dnd.mdx | ---
title: Drag & Drop
description: Allows movement of blocks, such as paragraph or tables, within the editor.
docs:
- route: /docs/components/draggable
title: Draggable
---
<ComponentPreview name="playground-demo" id="dnd" />
<PackageInfo>
## Features
- Drag & drop of blocks for content movement and insertio... | 8,424 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/emoji.mdx | ---
title: Emoji
description: Insert emoji inline.
docs:
- route: /docs/components/emoji-combobox
title: Emoji Combobox
- route: /docs/components/emoji-dropdown-menu
title: Emoji Dropdown Menu
- route: /docs/components/emoji-toolbar-dropdown
title: Emoji Toolbar Dropdown
---
<ComponentPreview name="p... | 8,425 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/excalidraw.mdx | ---
title: Excalidraw
description: Create drawings and diagrams as block nodes.
docs:
- route: /docs/components/excalidraw-element
title: Excalidraw Element
---
<ComponentPreview name="playground-demo" id="excalidraw" />
<PackageInfo>
## Features
- Integrates Excalidraw library for creation of drawings and di... | 8,426 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/exit-break.mdx | ---
title: Exit Break
description: Exit a large block using a shortcut.
---
<ComponentPreview name="playground-demo" id="exitbreak" />
<PackageInfo>
## Features
- Exit large text blocks with a single hotkey.
</PackageInfo>
## Installation
```bash
npm install @udecode/plate-break
```
## Usage
```tsx
import { cr... | 8,427 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/find-replace.mdx | ---
title: Find
description: Search and locate specific text or blocks within your document.
---
<Callout>
Work in progress.
</Callout>
- Search for whole words, word parts, or phrases with case matching.
[//]: # '- Use search input for find and replace operations.'
<PackageInfo>
## Installation
```bash
npm ins... | 8,428 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/font.mdx | ---
title: Font
description: Provide extended formatting options for document content.
docs:
- route: /docs/components/color-dropdown-menu
title: Color Dropdown Menu
---
<ComponentPreview name="playground-demo" id="font" />
<PackageInfo>
## Features
- Font size, family, color, background color, and weight.
*... | 8,429 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/forced-layout.mdx | ---
title: Forced Layout
description: Strict document structure.
---
<ComponentPreview name="playground-demo" id="forcedlayout" />
<PackageInfo>
## Features
- Automatically ensures the use of specified elements as required to maintain document structure (e.g., first block should be an H1 element).
</PackageInfo>
... | 8,430 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/getting-started.mdx | ---
title: Getting Started
description: A quick tutorial to get you up and running with Plate.
---
<Callout className="my-4">
Use our <Link href="/?builder=true" target="_blank">interactive builder</Link> to generate _personalized_ installation steps.
</Callout>
<Steps>
### Create project
You can choose one of th... | 8,431 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/highlight.mdx | ---
title: Highlight
description: Mark and reference text for review.
docs:
- route: /docs/components/highlight-leaf
title: Highlight Leaf
---
<ComponentPreview name="playground-demo" id="highlight" />
<PackageInfo>
## Features
- Provides text marking tools for content review and referencing.
- Uses inline `<... | 8,432 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/horizontal-rule.mdx | ---
title: Horizontal Rule
description: Visually divide and organize content sections with a horizontal line.
docs:
- route: /docs/components/hr-element
title: Hr Element
---
<ComponentPreview name="playground-demo" id="hr" />
<PackageInfo>
## Features
- Insert horizontal lines to separate content or indicate... | 8,433 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/indent-list.mdx | ---
title: Indent List
description: Turn any block into a list item.
docs:
- route: /docs/components/indent-list-toolbar-button
title: Indent List Toolbar Button
---
<ComponentPreview name="playground-demo" id="indentlist" />
<PackageInfo>
## Features
- Set list indentation for various blocks.
- Differs from ... | 8,434 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/indent.mdx | ---
title: Indent
description: Customize text indentation.
docs:
- route: /docs/components/indent-toolbar-button
title: Indent Toolbar Button
- route: /docs/components/outdent-toolbar-button
title: Outdent Toolbar Button
---
<ComponentPreview name="playground-demo" id="indent" />
<PackageInfo>
## Feature... | 8,435 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/index.mdx | ---
title: Introduction
description: The rich-text editor framework for React.
---
Plate is a powerful toolkit that makes it easier for you to develop with [Slate](https://docs.slatejs.org/), a popular framework for building text editors. Plate focuses on four main areas: **Core**, **Plugins**, **Primitives** and **Co... | 8,436 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/line-height.mdx | ---
title: Line Height
description: Adjust the height between lines of text.
docs:
- route: /docs/components/line-height-dropdown-menu
title: Line Height Dropdown Menu
---
<ComponentPreview name="playground-demo" id="lineheight" />
<PackageInfo>
## Features
- Set line height for selected blocks.
</PackageInf... | 8,437 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/link.mdx | ---
title: Link
description: Insert and manage hyperlinks.
docs:
- route: /docs/components/link-element
title: Link Element
- route: /docs/components/link-floating-toolbar
title: Link Floating Toolbar
- route: /docs/components/link-toolbar-button
title: Link Toolbar Button
---
<ComponentPreview name=... | 8,438 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/list.mdx | ---
title: List
description: Organize nestable items in a bulleted or numbered list.
docs:
- route: /docs/components/list-element
title: List Element
- route: /docs/components/list-toolbar-button
title: List Toolbar Button
- route: /docs/components/todo-list-element
title: Todo List Element
---
<Comp... | 8,439 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/media.mdx | ---
title: Media
description: Embed medias like videos or tweets into your document.
docs:
- route: /docs/components/image-element
title: Image Element
- route: /docs/components/media-embed-element
title: Media Embed Element
- route: /docs/components/media-popover
title: Media Popover
- route: /docs... | 8,440 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/mention.mdx | ---
title: Mention
description: Enable autocompletion for user mentions.
docs:
- route: /docs/components/combobox
title: Combobox
- route: /docs/components/mention-combobox
title: Mention Combobox
- route: /docs/components/mention-element
title: Mention Element
- route: /docs/components/mention-inpu... | 8,441 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/plugin-components.mdx | ---
title: Plugin Components
description: Markup and styling.
---
By default, Plate plugins are headless, meaning all nodes will be rendered as plain text. Follow this guide to learn how to create and style custom components for your editor.
## Plate UI
Unless you would prefer to build everything from scratch, we re... | 8,442 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/plugin.mdx | ---
title: Custom Plugins
description: How to create your own plugins.
---
Plugins are the building blocks of a Plate editor. Many plugins are provided out of the box, but you may find yourself needing to extend Plate with custom functionality. If that's the situation you're in, it's time to make a custom plugin.
- [... | 8,443 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/reset-node.mdx | ---
title: Reset Node
description: Reset the block type using rules.
---
<ComponentPreview name="playground-demo" id="resetnode" />
<PackageInfo>
## Features
- Enables quick reset of text block formatting to default on key events (e.g. `Enter`).
- To test, press Enter in an empty or at the end of a block quote, or ... | 8,444 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/serializing-csv.mdx | ---
title: Serializing CSV
description: Copy paste from CSV to Slate.
---
<ComponentPreview name="playground-demo" id="deserializecsv" />
<PackageInfo>
## Features
- Convert CSV content to a Slate value.
<Callout className="my-4">
**Note**: Converting a Slate value to CSV is not yet supported.
</Callout>
</Pack... | 8,445 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/serializing-docx.mdx | ---
title: Serializing Docx
description: Copy paste from DOCX to Slate.
---
<ComponentPreview name="playground-demo" id="deserializedocx" />
<PackageInfo>
## Features
- Convert DOCX content to a Slate value.
<Callout className="my-4">
**Note**: Converting a Slate value to DOCX is not yet supported.
</Callout>
<... | 8,446 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/serializing-html.mdx | ---
title: Serializing HTML
description: Copy paste from HTML to Slate.
---
<ComponentPreview name="playground-demo" id="deserializehtml" />
<PackageInfo>
## Features
- Convert a Slate value to a HTML string.
- Convert a HTML string to a Slate value.
<Callout className="my-4">
**Note**: Round-tripping is not yet... | 8,447 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/serializing-md.mdx | ---
title: Serializing Markdown
description: Copy paste from Markdown to Slate.
---
<ComponentPreview name="playground-demo" id="deserializemd" />
<PackageInfo>
## Features
- Convert Markdown content to a Slate value.
<Callout className="my-4">
**Note**: Converting a Slate value to Markdown is not yet supported.... | 8,448 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/single-line.mdx | ---
title: Single Line
description: Restrict the editor to a single block.
---
<ComponentPreview name="playground-demo" id="singleline" />
<PackageInfo>
## Features
- Limits editor to one block of text. Suitable for brief content or titles.
</PackageInfo>
## Installation
```bash
npm install @udecode/plate-break
... | 8,449 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/soft-break.mdx | ---
title: Soft Break
description: Insert line breaks within a block of text without starting a new block.
---
<ComponentPreview name="playground-demo" id="softbreak" />
<PackageInfo>
## Features
- Allows insertion of line breaks within a text block without starting a new block.
</PackageInfo>
## Installation
``... | 8,450 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/tabbable.mdx | ---
title: Tabbable
description: Maintain a consistent tab order for tabbable elements.
---
<ComponentPreview name="playground-demo" id="tabbable" />
<PackageInfo>
## Features
- Ensures consistent tab order between tabbable elements in the editor.
</PackageInfo>
## Installation
```bash
npm install @udecode/plate... | 8,451 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/table.mdx | ---
title: Table
description: Organize and display data in a structured and resizable tabular format.
docs:
- route: /docs/components/table-cell-element
title: Table Cell Element
- route: /docs/components/table-dropdown-menu
title: Table Dropdown Menu
- route: /docs/components/table-element
title: Tab... | 8,452 |
0 | petrpan-code/udecode/plate/apps/www/content | petrpan-code/udecode/plate/apps/www/content/docs/typescript.mdx | ---
title: Typescript
description: Generic types for Plate.
---
<Callout>
The core types will be the default of Slate in the near future, see [this
PR](https://github.com/ianstormtaylor/slate/pull/4177).
</Callout>
Plate delivers a structured typing layer built on top of Slate, which primarily employs [generic ty... | 8,453 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/api/common.mdx | ---
title: Plate Common
description: API reference for @udecode/plate-common.
---
`@udecode/plate-common` contains common types and functions for Plate packages:
- [Core](/docs/api/core)
- [Plate Utils](/docs/api/utils)
- [Slate](/docs/api/slate)
- [Slate React](/docs/api/slate-react)
| 8,454 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/api/core.mdx | ---
title: Plate Core
description: API reference for @udecode/plate-core.
---
## API
### `createPlugins`
Creates a new array of plugins by overriding the plugins in the original array.
<APIParameters>
<APIItem name="plugins" type="PlatePlugin[]" optional>
The original array of plugins.
</APIItem>
<APIItem name="opt... | 8,455 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/api/slate-react.mdx | ---
title: Slate React
description: API reference for @udecode/slate-react.
---
`@udecode/slate-react` extends Slate React API with generic types.
## React Editor
Find the corresponding documentation in the [Slate React docs](https://docs.slatejs.org/libraries/slate-react/react-editor).
### `SlateProps`
### `TReac... | 8,456 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/api/slate-utils.mdx | ---
title: Slate Utils
description: API reference for @udecode/slate-utils.
---
`@udecode/slate-utils` contains utility functions for Slate.
## Queries
### findDescendant
Iterates through all nodes in the editor and returns the first match. If no match is found, returns undefined.
<APIParameters>
<APIItem name="... | 8,457 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/api/slate.mdx | ---
title: Slate
description: API reference for @udecode/slate.
---
`@udecode/slate` extends Slate API with generic types.
## Editor
Find the corresponding documentation in the [Slate docs](https://docs.slatejs.org/api/transforms).
### `addMark`
### `createPathRef`
### `createPointRef`
### `createRangeRef`
### ... | 8,458 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/api/utils.mdx | ---
title: Plate Utils
description: API reference for @udecode/plate-utils.
---
`@udecode/plate-utils` contains utility functions for Plate.
## Components
### PlateElement
Generic component for rendering an element.
<APIAttributes>
PlateElementProps.
<APIItem name="className" type="string" optional>
The CSS clas... | 8,459 |
0 | petrpan-code/udecode/plate/apps/www/content/docs/api | petrpan-code/udecode/plate/apps/www/content/docs/api/core/plate-editor.mdx | ---
title: Plate Editor
description: API reference for Plate editor.
---
A custom editor interface that extends the base **`TEditor`**, **`THistoryEditor`**, and **`TReactEditor`** interfaces and includes additional properties and methods specific to the Plate library.
<APIParameters>
<APIItem
name="blockFactor... | 8,460 |
0 | petrpan-code/udecode/plate/apps/www/content/docs/api | petrpan-code/udecode/plate/apps/www/content/docs/api/core/plate-plugin.mdx | ---
title: PlatePlugin
description: API reference for Plate plugins.
---
Plate plugins are objects passed to `Plate` [plugins](/docs/api/core/plate#plugins) prop.
<APIAttributes>
<APIItem name="key" type="string" required>
Property used by Plate to store the plugins by key in `editor.pluginsByKey`.
- Unique in the ... | 8,461 |
0 | petrpan-code/udecode/plate/apps/www/content/docs/api | petrpan-code/udecode/plate/apps/www/content/docs/api/core/plate.mdx | ---
title: Plate
description: API reference for Plate component.
---
`Plate` is the root component loading the editor state into a store provider.
`PlateContent` is the component that renders the editor.
## Plate Props
<APIParameters>
<APIItem name="id" type="string" optional>
A unique ID to store the editor sta... | 8,462 |
0 | petrpan-code/udecode/plate/apps/www/content/docs/api | petrpan-code/udecode/plate/apps/www/content/docs/api/core/store.mdx | ---
title: Store
description: API reference for Plate store.
---
`Plate` is using [jotai](https://github.com/pmndrs/jotai) to store the state of the editor.
<Callout className="my-4">
**Note**: To use the store hooks in a component, it needs to be rendered
inside `Plate`.
</Callout>
## Plate Store
### State
Th... | 8,463 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/align-dropdown-menu.mdx | ---
title: Align Dropdown Menu
description: Select and adjust alignment options for your content.
component: true
docs:
- route: /docs/alignment
title: Alignment
- route: /docs/components/dropdown-menu
title: Dropdown Menu
- route: /docs/components/toolbar
title: Toolbar
---
## Installation
<Tabs de... | 8,464 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/avatar.mdx | ---
title: Avatar
description: An image element with a fallback for representing the user.
component: true
radix:
shadcn: https://ui.shadcn.com/docs/components/avatar
api: https://www.radix-ui.com/docs/primitives/components/avatar#api-reference
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigge... | 8,465 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/blockquote-element.mdx | ---
title: Block Quote Element
description: Add a blockquote to emphasize quoted text within your content.
component: true
docs:
- route: /docs/basic-elements
title: Block Quote
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manua... | 8,466 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/button.mdx | ---
title: Button
description: Displays a button or a component that looks like a button.
component: true
radix:
shadcn: https://ui.shadcn.com/docs/components/button
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>
... | 8,467 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/caption.mdx | ---
title: Caption
description: Add captions to your blocks.
component: true
docs:
- route: /docs/caption
title: Caption
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>
<TabsContent value="cli">
``... | 8,468 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/changelog.mdx | ---
title: Changelog
description: Latest component updates and announcements.
toc: true
---
Since Plate UI is not a component library, a changelog is maintained here.
Use the [CLI](https://platejs.org/docs/components/cli) to install the latest version of the components.
## November 2023 #5
### 5 Nov #5.1
- `commen... | 8,469 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/checkbox.mdx | ---
title: Checkbox
description: A control that allows the user to toggle between checked and not checked.
component: true
radix:
shadcn: https://ui.shadcn.com/docs/components/checkbox
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Ma... | 8,470 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/cli.mdx | ---
title: CLI
description: Use the CLI to add components to your project.
---
## init
Use the `init` command to initialize configuration and dependencies for a new project.
The `init` command installs dependencies, adds the `cn` util, configures `tailwind.config.js`, and CSS variables for the project.
```bash
npx ... | 8,471 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/cloud.mdx | ---
title: Cloud
description: Integrate cloud functionality to enable seamless access to cloud-based resources.
component: true
docs:
- route: /docs/cloud
title: Cloud
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTri... | 8,472 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/code-block-element.mdx | ---
title: Code Block Element
description: Insert a formatted block of code into your content.
component: true
docs:
- route: /docs/basic-elements
title: Code Block
- route: /docs/components/command
title: Command
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</Tabs... | 8,473 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/code-leaf.mdx | ---
title: Code Leaf
description: Apply inline styling to denote code snippets within your text.
component: true
docs:
- route: /docs/basic-marks
title: Basic Marks
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigge... | 8,474 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/code-line-element.mdx | ---
title: Code Line Element
description: Display a single line of code within your content.
component: true
docs:
- route: /docs/basic-elements
title: Code Block
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>... | 8,475 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/code-syntax-leaf.mdx | ---
title: Code Syntax Leaf
description: Highlight syntax elements within code snippets.
component: true
docs:
- route: /docs/basic-elements
title: Code Block
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>
</T... | 8,476 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/color-dropdown-menu.mdx | ---
title: Color Dropdown Menu
description: Choose and apply colors to your content from a dropdown menu.
component: true
docs:
- route: /docs/font
title: Font
- route: /docs/components/dropdown-menu
title: Dropdown Menu
- route: /docs/components/toolbar
title: Toolbar
- route: /docs/components/sepa... | 8,477 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/combobox.mdx | ---
title: Combobox
description: Combine a text input field with a dropdown menu for enhanced user interaction.
component: true
docs:
- route: /docs/combobox
title: Combobox
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</T... | 8,478 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/command.mdx | ---
title: Command
description: Fast, composable, unstyled command menu for React.
component: true
radix:
shadcn: https://ui.shadcn.com/docs/components/command
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>
</Tabs... | 8,479 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/comment-leaf.mdx | ---
title: Comment Leaf
description: Add comments to specific sections of your content.
component: true
docs:
- route: /docs/comments
title: Comments
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>
... | 8,480 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/comment-toolbar-button.mdx | ---
title: Comment Toolbar Button
description: Access comment-related features and functionality through a toolbar button.
component: true
docs:
- route: /docs/comments
title: Comments
- route: /docs/components/toolbar
title: Toolbar
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger v... | 8,481 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/comments-popover.mdx | ---
title: Comments Popover
description: View and manage comments within a popover interface.
component: true
docs:
- route: /docs/comments
title: Comments
- route: /docs/components/popover
title: Popover
- route: /docs/components/avatar
title: Avatar
---
## Installation
<Tabs defaultValue="cli">
<... | 8,482 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/components-json.mdx | ---
title: components.json
description: Configuration for your project.
---
The `components.json` file holds configuration for your project.
We use it to understand how your project is set up and how to generate components customized for your project.
<Callout className="mt-6">
Note: The `components.json` file is ... | 8,483 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/cursor-overlay.mdx | ---
title: Cursor Overlay
description: Overlay a cursor indicator for collaborative editing or real-time interaction.
component: true
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>
<TabsContent value="cl... | 8,484 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/dialog.mdx | ---
title: Dialog
description: A window overlaid on either the primary window or another dialog window, rendering the content underneath inert.
component: true
radix:
shadcn: https://ui.shadcn.com/docs/components/dialog
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrig... | 8,485 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/draggable.mdx | ---
title: Draggables
description: Allows movement of blocks, such as paragraph or tables, within the editor.
component: true
docs:
- route: /docs/dnd
title: Drag & Drop
- route: /docs/components/tooltip
title: Tooltip
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI<... | 8,486 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/dropdown-menu.mdx | ---
title: Dropdown Menu
description: Display a menu of options for selection within a dropdown interface.
component: true
radix:
shadcn: https://ui.shadcn.com/docs/components/dropdown-menu
api: https://www.radix-ui.com/docs/primitives/components/dropdown-menu#api-reference
---
## Installation
<Tabs defaultValue=... | 8,487 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/editor.mdx | ---
title: Editor
description: From Textarea to WYSIWYG editor.
component: true
docs:
- route: /docs/api/core/plate
title: Plate
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>
<TabsContent val... | 8,488 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/emoji-combobox.mdx | ---
title: Emoji Combobox
description: Enter and select emojis using a combination of text input and a dropdown menu.
component: true
docs:
- route: /docs/combobox
title: Combobox
- route: /docs/emoji
title: Emoji
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</Tabs... | 8,489 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/emoji-dropdown-menu.mdx | ---
title: Emoji Dropdown Menu
description: Access a wide range of emojis from a dropdown menu.
component: true
docs:
- route: /docs/components/toolbar
title: Toolbar
- route: /docs/emoji
title: Emoji
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<Tab... | 8,490 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/emoji-toolbar-dropdown.mdx | ---
title: Emoji Toolbar Dropdown
description: Display an emoji selection menu within a toolbar interface.
component: true
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>
<TabsContent value="cli">
```bas... | 8,491 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/excalidraw-element.mdx | ---
title: Excalidraw Element
description: Embed Excalidraw diagrams or illustrations into your content.
component: true
docs:
- route: /docs/excalidraw
title: Excalidraw
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</Tabs... | 8,492 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/fixed-toolbar-buttons.mdx | ---
title: Fixed Toolbar Buttons
description: Access frequently used toolbar buttons that remain fixed during scrolling.
component: true
docs:
- route: /docs/basic-marks
title: Basic Marks
- route: /docs/components/toolbar
title: Toolbar
- route: /docs/components/insert-dropdown-menu
title: Insert Dro... | 8,493 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/fixed-toolbar.mdx | ---
title: Fixed Toolbar
description: Keep the toolbar fixed in a specific position while scrolling through the content.
component: true
docs:
- route: /docs/components/toolbar
title: Toolbar
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value=... | 8,494 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/floating-toolbar-buttons.mdx | ---
title: Floating Toolbar buttons
description: Display toolbar buttons that dynamically adjust their position while scrolling.
component: true
docs:
- route: /docs/basic-marks
title: Basic Marks
- route: /docs/components/mark-toolbar-button
title: Mark Toolbar Button
- route: /docs/components/more-dropd... | 8,495 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/floating-toolbar.mdx | ---
title: Floating Toolbar
description: A toolbar that floats above the editor at the current selection.
component: true
docs:
- route: /docs/components/toolbar
title: Toolbar
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual... | 8,496 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/heading-element.mdx | ---
title: Heading Element
description: Apply heading styles to create hierarchical structure within your content.
component: true
docs:
- route: /docs/basic-elements
title: Basic Elements
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="ma... | 8,497 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/highlight-leaf.mdx | ---
title: Highlight Leaf
description: Mark and highlight specific portions of text within your content.
component: true
docs:
- route: /docs/highlight
title: Highlight
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTr... | 8,498 |
0 | petrpan-code/udecode/plate/apps/www/content/docs | petrpan-code/udecode/plate/apps/www/content/docs/components/hr-element.mdx | ---
title: Hr Element
description: Insert a horizontal rule to visually separate sections or content.
component: true
docs:
- route: /docs/horizontal-rule
title: Horizontal Rule
---
## Installation
<Tabs defaultValue="cli">
<TabsList>
<TabsTrigger value="cli">CLI</TabsTrigger>
<TabsTrigger value="manual">Manua... | 8,499 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.