Filament Tiptap Editor

https://github.com/awcodes/filament-tiptap-editor
Admin
Filament Tiptap Editor is a WYSIWYG editor integration for Filament Admin and Forms that provides...
Tokens:74,188
Snippets:556
Trust Score:9.6
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install filament-tiptap-editor via Composer

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Install the package via Composer. Requires Filament v3 and a custom theme setup.

```bash
composer require awcodes/filament-tiptap-editor:"^3.0"
```

--------------------------------

### getExtensions method signature

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-converter.md

Returns the parser extension list, starting from StarterKit with listItem disabled and adding many custom nodes and marks.

```php
public function getExtensions(): array
```

--------------------------------

### Provide dynamic mention suggestions with getMentionItemsUsing

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Provide dynamic mention suggestions via a callback that receives the search query. The example searches users and returns up to 5 MentionItem objects.

```php
TiptapEditor::make(name: 'content')
    ->getMentionItemsUsing(function (string $query) {
        // Get suggestions based of the $query
        return User::search($query)->get()->map(fn ($user) => new MentionItem(
            id: $user->id,
            label: $user->name
        ))->take(5)->toArray();
    })
```

--------------------------------

### Configure menus with disableFloatingMenus, disableBubbleMenus, floatingMenuTools, and tippyPlacement

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Example usage of the menu configuration methods. Disables floating and bubble menus, sets floating menu tools, and changes the tippy placement to left.

```php
use FilamentTiptapEditor\Enums\TippyPlacement;

TiptapEditor::make('content')
    ->disableFloatingMenus()
    ->disableBubbleMenus()
    ->floatingMenuTools(['grid-builder', 'media', 'link'])
    ->tippyPlacement(TippyPlacement::Left);
```

--------------------------------

### blocks tool dropdown example

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/blade-components.md

Example usage of the dropdown-button and dropdown-button-item components for the 'blocks' tool. It iterates over $blocks and renders a dropdown-button-item for each, passing an action that mounts the 'insertBlock' form component action with the block type.

```blade
<x-filament-tiptap-editor::dropdown-button
    label="{{ trans('filament-tiptap-editor::editor.blocks.insert') }}"
    icon="blocks"
    :active="true"
>
    @foreach($blocks as $key => $block)
        <x-filament-tiptap-editor::dropdown-button-item
            action="$wire.mountFormComponentAction('{{ $statePath }}', 'insertBlock', { type: '{{ $key }}' })"
        >
            {{ $block->getLabel() }}
        </x-filament-tiptap-editor::dropdown-button-item>
    @endforeach
</x-filament-tiptap-editor::dropdown-button>
```

--------------------------------

### make:tiptap-block command usage

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/service-provider.md

Usage examples for the make:tiptap-block command. The name is optional; when omitted an interactive prompt asks for it. The --force option overwrites existing files.

```bash
php artisan make:tiptap-block BatmanBlock
php artisan make:tiptap-block Admin/BatmanBlock
php artisan make:tiptap-block BatmanBlock --force   # overwrite existing files

```

--------------------------------

### Global config action override with link_action

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/actions.md

Set a global configuration value for the link action using the 'link_action' key. The example assigns 'App\Actions\MyLinkAction::class'.

```php
// global config
'link_action' => App\Actions\MyLinkAction::class,
```

--------------------------------

### Configure mentions on TiptapEditor

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Example configuration for the TiptapEditor component using the HasMentions methods. It sets static mention items, changes the search strategy to Tokenized, uses '#' as the trigger, sets a 300 ms debounce, and caps the maximum mention items to 5.

```php
use FilamentTiptapEditor\Data\MentionItem;
use FilamentTiptapEditor\Enums\MentionSearchStrategy;

TiptapEditor::make('content')
    ->mentionItems([
        new MentionItem(label: 'Banana', id: 1, href: 'https://filamentphp.com'),
        ['label' => 'Apple', 'id' => 2],
    ])
    ->mentionSearchStrategy(MentionSearchStrategy::Tokenized)
    ->mentionTrigger('#')
    ->mentionDebounce(300)
    ->maxMentionItems(5);
```

--------------------------------

### Create a custom block class with getFormSchema

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Example block class extending TiptapBlock. Defines preview and rendered blade views and a form schema with name, color, and side fields.

```php
use FilamentTiptapEditor\TiptapBlock;

class BatmanBlock extends TiptapBlock
{
    public string $preview = 'blocks.previews.batman';

    public string $rendered = 'blocks.rendered.batman';

    public function getFormSchema(): array
    {
        return [
            TextInput::make('name'),
            TextInput::make('color'),
            Select::make('side')
                ->options([
                    'Hero' => 'Hero',
                    'Villain' => 'Villain',
                ])
                ->default('Hero')
        ];
    }
}
```

--------------------------------

### Usage example: generate demo HTML and JSON with TiptapFaker

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-faker.md

Builds a demo payload for a seeder: chains content methods, then produces HTML output via `asHTML()` or a JSON string via `asJSON(decoded: false)`. The faker is the supported way to generate varied input for editor fields in tests and fixtures.

```php
use FilamentTiptapEditor\TiptapFaker;

$faker = TiptapFaker::make();

$faker
    ->heading()
    ->paragraphs(2, withRandomLinks: true)
    ->image(800, 600)
    ->video(provider: 'youtube', responsive: false)
    ->sink();

$html = $faker->asHTML();

$json = TiptapFaker::make()
    ->heading(3)
    ->details()
    ->asJSON(decoded: false); // JSON string for a json column
```

--------------------------------

### Set mention search strategy

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Set the mention search strategy. Default is 'starts with' (MentionSearchStrategy::StartsWith); use MentionSearchStrategy::Tokenized for matching multiple keywords within a label.

```php
TiptapEditor::make(name: 'content')
    // You can also use MentionSearchStrategy::Tokenized
    ->mentionSearchStrategy(MentionSearchStrategy::StartsWith)
```

--------------------------------

### Generated block stub example

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/service-provider.md

Generated block stub from stubs/Block.stub. It extends TiptapBlock and defines preview and rendered view names, plus a getFormSchema method to be filled in.

```php
namespace App\TiptapBlocks\Admin;

use FilamentTiptapEditor\TiptapBlock;

class BatmanBlock extends TiptapBlock
{
    public string $preview = 'app.tiptap_blocks.admin.previews.batman_block';

    public string $rendered = 'app.tiptap_blocks.admin.rendered.batman_block';

    public function getFormSchema(): array
    {
        return [
            //
        ];
    }
}

```

--------------------------------

### collapseBlocksPanel and shouldCollapseBlocksPanel method signatures

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Controls whether the drag-and-drop blocks panel starts collapsed.

```php
public function collapseBlocksPanel(bool $condition = true): static
public function shouldCollapseBlocksPanel(): bool
```

--------------------------------

### Per-instance action override with linkAction and mediaAction

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/actions.md

Assign custom action classes per instance using the linkAction and mediaAction methods. The example shows setting 'App\Actions\MyLinkAction' and 'App\Actions\MyMediaAction'.

```php
// per instance
TiptapEditor::make('content')
    ->linkAction('App\Actions\MyLinkAction')
    ->mediaAction('App\Actions\MyMediaAction');
```

--------------------------------

### Re-export index of public extensions

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/js-extensions.md

This snippet shows the contents of resources/js/extensions/index.js, which re-exports all public extension objects. Import these from "./extensions" to use them in your Tiptap setup.

```javascript
export { CheckedList } from "./CheckedList";
export { Lead } from "./Lead";
export { CustomLink } from "./Link";
export { CustomImage } from "./Image";
export { CustomParagraph } from "./Paragraph";
export { Small } from "./Small";
export { Grid } from "./Grid/Grid";
export { GridColumn } from "./Grid/GridColumn";
export { Youtube } from "./Youtube/Youtube";
export { Vimeo } from "./Vimeo/Vimeo";
export { Video } from "./Video";
export { Details } from "./Details/Details";
export { DetailsSummary } from "./Details/DetailsSummary";
export { DetailsContent } from "./Details/DetailsContent";
export { CustomCodeBlockLowlight } from "./CodeBlock";
export { Hurdle } from "./Hurdle";
export { CustomTextAlign } from "./CustomTextAlign";
export { GridBuilder } from "./GridBuilder/GridBuilder";
export { GridBuilderColumn } from "./GridBuilder/GridBuilderColumn";
export { DragAndDropExtension } from "./DragAndDrop.js";
export { TiptapBlock } from "./TiptapBlock.js";
export { MergeTag } from "./MergeTag.js";
export { ClassExtension } from "./ClassExtension.js";
export { IdExtension } from "./IdExtension.js";
export { StyleExtension } from "./StyleExtension.js";
export { CustomMention } from "./Mention/Mention.js";
export { StatePath } from './StatePath.js';
```

--------------------------------

### nodePlaceholders and getNodePlaceholders method signatures

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Sets per-node-type placeholders, e.g. ['heading' => 'What's the title?', 'paragraph' => 'Start writing here...']. The getter returns the configured array or null.

```php
public function nodePlaceholders(array | Closure | null $nodePlaceholders): static
public function getNodePlaceholders(): ?array
```

--------------------------------

### Table of Contents Component Usage

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/blade-components.md

Usage example for the table-of-contents component. Passes the nested headings array generated by tiptap_converter()->asTOC() with the 'array' option set to true.

```blade
<x-filament-tiptap-editor::table-of-contents :headings="tiptap_converter()->asTOC($page->body, array: true)" />
```

--------------------------------

### CanStoreOutput trait: output format methods

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Declares the output format property and the public API methods for the CanStoreOutput trait. The output() method sets the storage format, getOutput() returns the configured format, and the get* methods delegate to the TiptapConverter facade. The expects* methods check the resolved output format against the TiptapOutput enum.

```php
protected ?TiptapOutput $output = null;

public function output(TiptapOutput $output): static
public function getOutput(): TiptapOutput
public function getHTML(): string
public function getText(): string
public function getJSON(bool $decoded = false): string | array
public function expectsHTML(): bool
public function expectsJSON(): bool
public function expectsText(): bool
```

--------------------------------

### getMaxContentWidth

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Gets the maximum content width for the editor.

```APIDOC
## getMaxContentWidth

### Description
Evaluates `maxContentWidth` (resolving Closures) or returns `config('filament-tiptap-editor.max_content_width')`.

### Method
`getMaxContentWidth`

### Signature
```php
public function getMaxContentWidth(): string
```

### Parameters
None

### Return Value
`string` - The maximum content width.

### Source
`src/TiptapEditor.php:390`
```

--------------------------------

### Lead methods

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/extensions-nodes.md

Renders a <div> with class 'lead'. Methods configure HTML attributes, parse HTML for the class, and render the element.

```php
public function addOptions(): array  // HTMLAttributes.class = 'lead'
public function parseHTML(): array   // tag 'div' when class contains 'lead'
public function renderHTML($node, $HTMLAttributes = []): array
```

--------------------------------

### collapseBlocksPanel / shouldCollapseBlocksPanel

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Sets and retrieves whether the blocks panel starts collapsed.

```APIDOC
## collapseBlocksPanel / shouldCollapseBlocksPanel

### Description
Controls whether the drag-and-drop blocks panel starts collapsed.

### Method
`collapseBlocksPanel(bool $condition = true): static`
`shouldCollapseBlocksPanel(): bool`

### Parameters
- `$condition` (bool) - Optional - Whether to collapse the panel. Defaults to `true`.

### Returns
- `static` for `collapseBlocksPanel`
- `bool` for `shouldCollapseBlocksPanel`
```

--------------------------------

### Configure profiles and tools in filament-tiptap-editor.php

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Defines the three built-in profiles (default, simple, minimal) in the config file. Use a pipe `|` to separate tools into groups. The default profile is the full set of tools.

```php
'profiles' => [
    'default' => [
        'heading', 'bullet-list', 'ordered-list', 'checked-list', 'blockquote', 'hr',
        'bold', 'italic', 'strike', 'underline', 'superscript', 'subscript', 'lead', 'small', 'align-left', 'align-center', 'align-right',
        'link', 'media', 'oembed', 'table', 'grid-builder', 'details',
        'code', 'code-block', 'source',
    ],
    'simple' => [
        'heading', 'hr', 'bullet-list', 'ordered-list', 'checked-list',
        'bold', 'italic', 'lead', 'small',
        'link', 'media',
    ],
    'minimal' => [
        'bold', 'italic', 'link', 'bullet-list', 'ordered-list',
    ],
],
```

--------------------------------

### Configure media and image settings

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Configuration array for media handling, specifying accepted file types, storage disk, directory, visibility, file name preservation, max file size, and image resize/crop options.

```php
[
    'accepted_file_types' => ['image/jpeg', 'image/png', 'image/webp', 'image/svg+xml', 'application/pdf'],
    'disk' => 'public',
    'directory' => 'images',
    'visibility' => 'public',
    'preserve_file_names' => false,
    'max_file_size' => 2042,
    'image_crop_aspect_ratio' => null,
    'image_resize_target_width' => null,
    'image_resize_target_height' => null,
]
```

--------------------------------

### Create a custom Tiptap extension (JS)

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Create a custom Tiptap extension file in `resources/js/tiptap` (e.g., `hero.js`). The extension defines a node named "hero" and is exported as the default export.

```js
import { Node, mergeAttributes } from "@tiptap/core";

const Hero = Node.create({
    name: "hero",
    ...
})

export default Hero

```

--------------------------------

### Configure media upload options with InteractsWithMedia

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Configures media upload options on a TiptapEditor instance. The methods map to the InteractsWithMedia concern's configuration, with fallbacks to the editor's config values. Note that maxFileSize() is deprecated in favor of maxSize(), and maxSize() expects kilobytes.

```php
TiptapEditor::make('content')
    ->disk('public')
    ->directory('images')
    ->acceptedFileTypes(['image/jpeg', 'image/png', 'image/webp', 'image/svg+xml', 'application/pdf'])
    ->maxSize(2042)
    ->minSize(0)
    ->visibility('public')
    ->preserveFileNames(false);
```

--------------------------------

### getExtensions

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-converter.md

Returns the list of parser extensions used by the converter, including StarterKit and custom nodes/marks.

```APIDOC
## getExtensions

### Description
Returns the parser extension list. It starts from `Tiptap\Extensions\StarterKit` (with `'listItem' => false`), then adds various built-in and custom extensions.

### Method
`getExtensions`

### Signature
```php
public function getExtensions(): array
```

### Returns
- **array** - Array of extension instances.

### Source
`src/TiptapConverter.php:45`
```

--------------------------------

### Using HasFormMentions trait in a Livewire component

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Usage example for the HasFormMentions trait. Mix this trait into a Livewire component that hosts forms with TiptapEditor fields to enable dynamic mentions.

```php
use FilamentTiptapEditor\Concerns\HasFormMentions;

class MyFormPage
{
    use HasFormMentions;
    // ...
}
```

--------------------------------

### Register custom extensions in extensions.js

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Create `resources/js/tiptap/extensions.js` to register custom extensions. Each extension must be registered as a key:array set, where the key is the extension name and the value is an array containing the extension class.

```js
import Hero from "./hero.js";

window.TiptapEditorExtensions = {
    hero: [Hero]
}

```

--------------------------------

### TiptapFaker::make()

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-faker.md

Factory method to create a TiptapFaker instance.

```APIDOC
## TiptapFaker::make()

### Description
Creates a new TiptapFaker instance with a Faker factory. This is the factory method to use instead of a constructor.

### Method
`public static function make(): static`

### Parameters
None.

### Returns
- `static` - A new TiptapFaker instance.

### Example
```php
$faker = TiptapFaker::make();
```
```

--------------------------------

### MakeBlockCommand properties and handle method

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/service-provider.md

Properties and method signature for the MakeBlockCommand. The signature defines the command name, optional name argument, and force option.

```php
protected $description = 'Create a new Tiptap Editor block';

protected $signature = 'make:tiptap-block {name?} {--F|force}';

public function handle(): int

```

--------------------------------

### TiptapFaker::grid()

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-faker.md

Appends a responsive grid builder to the output buffer.

```APIDOC
## TiptapFaker::grid()

### Description
Appends a responsive grid builder div (`<div class="filament-tiptap-grid-builder" ...>`) with columns to the output buffer. Each column contains an `<h2>` and a `<p>`.

### Method
`public function grid(array $cols = [1, 1, 1]): static`

### Parameters
- `$cols` (array) - Optional - Array of column span values. Defaults to [1, 1, 1].

### Returns
- `static` - The current instance for chaining.

### Example
```php
$faker->grid([2, 1]);
```
```

--------------------------------

### Store JSON content with migration and model cast

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Required database setup when storing editor content as JSON or array: use a `json` column type in the migration and cast the attribute to `json` or `array` in the model.

```php
// in your migration
$table->json('content');

// in your model
protected $casts = [
    'content' => 'json' // or 'array'
];
```

--------------------------------

### Set placeholder with placeholder()

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Sets a default placeholder for the editor.

```php
TiptapEditor::make('content')
    ->placeholder('Write something...')
```

--------------------------------

### getEditor method signature

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-converter.md

Lazily creates and caches a Tiptap\Editor configured with getExtensions().

```php
public function getEditor(): Editor
```

--------------------------------

### Custom Tool Button Blade Component

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/blade-components.md

Custom tool button example for extending the toolbar. Place this in your app's resources/views/components and reference it via the extension config's 'button' key. The 'action' attribute calls the editor command toggleHero().

```blade
<x-filament-tiptap-editor::button
    label="Hero"
    active="hero"
    action="editor().commands.toggleHero()"
>
    <svg ...>…</svg>
    <span class="sr-only">{{ $label }}</span>
</x-filament-tiptap-editor::button>
```

--------------------------------

### YouTube node extension method signatures

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/extensions-nodes.md

Method signatures for the YouTube node extension. The parseHTML method targets the 'div[data-youtube-video]' tag. The renderHTML method builds the embed URL from the src attribute, including controls, nocookie, and start handling.

```php
public function addOptions(): array
public function addAttributes(): array
public function parseHTML(): array   // tag 'div[data-youtube-video]'
public function renderHTML($node, $HTMLAttributes = []): array
```

--------------------------------

### getTools method signature

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Returns the instance's tool list. Tool identifiers matching config('filament-tiptap-editor.extensions') are replaced with the full extension config array.

```php
public function getTools(): array
```

--------------------------------

### PHP: Extension registration order in TiptapConverter::getExtensions()

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/extensions-marks-globals.md

Shows the exact order of extension registration in the TiptapConverter::getExtensions() method. Custom extension classes from config('filament-tiptap-editor.extensions') with a 'parser' are appended last, and they may be nodes, marks, or plain extensions depending on what the app author's class extends.

```php
new StarterKit(['listItem' => false]),
new TextStyle,
new Extensions\TextAlign(['types' => ['heading', 'paragraph']]),
new Extensions\ClassExtension,
new Extensions\IdExtension,
new Extensions\StyleExtension,
new Extensions\Color,
new CodeBlockHighlight,
new Nodes\ListItem, new Nodes\Lead, new Nodes\Image, new Nodes\CheckedList,
new Nodes\Details, new Nodes\DetailsSummary, new Nodes\DetailsContent,
new Nodes\Grid, new Nodes\GridColumn, new Nodes\GridBuilder, new Nodes\GridBuilderColumn,
new Nodes\MergeTag, new Nodes\Vimeo, new Nodes\YouTube, new Nodes\Video,
new Nodes\TiptapBlock(['blocks' => $this->blocks]), new Nodes\Hurdle, new Nodes\Mention,
new Table, new TableHeader, new TableRow, new TableCell,
new Highlight, new Underline, new Superscript, new Subscript,
new Marks\Link(['protocols' => config('filament-tiptap-editor.link_protocols', [])]),
new Marks\Small,
...$customExtensions,
```

--------------------------------

### Youtube URL validation and embed URL utilities

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/js-extensions.md

Exports three functions: isValidYoutubeUrl checks for youtube.com or youtu.be domains, getYoutubeEmbedUrl returns the embed base URL (standard or nocookie), and getEmbedURLFromYoutubeURL builds the full embed URL with controls and start parameters.

```javascript
export const isValidYoutubeUrl = (url) => url.match(/(youtube\.com|youtu\.be)(.+)?$/);
export const getYoutubeEmbedUrl = (nocookie = false) => // youtube.com vs youtube-nocookie.com embed base
export const getEmbedURLFromYoutubeURL = (options) =>    // { url, controls, nocookie, startAt } → embed URL with controls & start params
```

--------------------------------

### getEditor

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-converter.md

Lazily creates and caches a Tiptap\Editor instance configured with the converter's extensions.

```APIDOC
## getEditor

### Description
Lazily creates and caches a `Tiptap\Editor` configured with `getExtensions()`.

### Method
`getEditor`

### Signature
```php
public function getEditor(): Editor
```

### Returns
- **Editor** - The cached Tiptap Editor instance.

### Source
`src/TiptapConverter.php:31`
```

--------------------------------

### Publish filament-tiptap-editor config

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/configuration.md

Run this artisan command to publish the configuration file. The published file is located at config/filament-tiptap-editor.php in the consuming app, where you can edit defaults, add profile entries, or register custom extensions.

```bash
php artisan vendor:publish --tag="filament-tiptap-editor-config"
```

--------------------------------

### HasCustomActions property and method signatures

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Declares the properties and method signatures for overriding the Filament form component Actions that power the modals (link, media, edit media, grid builder, oEmbed). Each *Action(string | Closure) stores the fully-qualified action class name from which ::make() is invoked, and each get*Action() resolves via evaluate() with fallback to config keys link_action, media_action, edit_media_action, grid_builder_action, and oembed_action.

```php
public ?string $linkAction = null;
public ?string $mediaAction = null;
public ?string $editMediaAction = null;
public ?string $gridBuilderAction = null;
public ?string $oembedAction = null;

public function linkAction(string | Closure $action): static
public function mediaAction(string | Closure $action): static
public function oembedAction(string | Closure $action): static
public function editMediaAction(string | Closure $action): static
public function gridBuilderAction(string | Closure $action): static

public function getLinkAction(): Action
public function getMediaAction(): Action
public function getEditMediaAction(): Action
public function getGridBuilderAction(): Action
public function getOEmbedAction(): Action
```

--------------------------------

### Three equivalent call styles for TiptapConverter

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-converter.md

Shows the three equivalent ways to call the converter: the direct class, the Laravel facade alias, and the global helper. All three produce the same result.

```php
use FilamentTiptapEditor\TiptapConverter;
use FilamentTiptapEditor\Facades\TiptapConverter as FacadeTiptapConverter;

TiptapConverter::asHTML($content);
FacadeTiptapConverter::asHTML($content);   // Laravel facade
tiptap_converter()->asHTML($content);      // global helper
```

--------------------------------

### Set custom floating menu tools per instance

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Provide custom tools for the floating menu on a per-instance basis using the floatingMenuTools() method. The default tools can be overwritten via the config file.

```php
TiptapEditor::make('content')
    ->floatingMenuTools(['grid-builder', 'media', 'link'])
```

--------------------------------

### configurePackage method and package configuration

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/service-provider.md

Declares the package metadata for spatie/laravel-package-tools. The method signature is followed by the package configuration chain that registers config, assets, translations, commands, and views.

```php
public function configurePackage(Package $package): void

```

```php
$package
    ->name('filament-tiptap-editor')
    ->hasConfigFile()
    ->hasAssets()
    ->hasTranslations()
    ->hasCommands([
        MakeBlockCommand::class,
    ])
    ->hasViews();

```

--------------------------------

### Add custom extension CSS

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Create `resources/css/tiptap/extensions.css` for custom extension styles. All styles should be scoped to the parent class `.tiptap-content`.

```css
.tiptap-content {
    .hero-block {
        ...
    }
}

```

--------------------------------

### getPreview method

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-block.md

Renders the preview view with block data and the surrounding component. Throws Throwable from Blade rendering.

```php
/**
 * @throws Throwable
 */
public function getPreview(?array $data = null, ?Component $component = null): string
```

--------------------------------

### Set default floating and bubble menu tools in config

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Configure the default tools for the floating and bubble menus via the config file. These defaults can be overwritten per instance.

```php
'floating_menu_tools' => ['media', 'grid-builder', 'details', 'table', 'oembed', 'code-block'],
'bubble_menu_tools' => ['bold', 'italic', 'strike', 'underline', 'superscript', 'subscript', 'lead', 'small', 'link'],
```

--------------------------------

### Enable RTL support with 'direction' => 'rtl'

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Enables RTL support by setting the `direction` key to 'rtl' in the config file. This ensures features like text alignment work correctly with RTL languages.

```php
// config/filament-tiptap-editor.php
'direction' => 'rtl'
```

--------------------------------

### Configure static mentions with MentionItem objects

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Configure static mention suggestions using MentionItem objects. Each item can include a label, id, optional href for clickable output, and optional data stored in the final JSON.

```php
TiptapEditor::make(name: 'content')
    ->mentionItems([
        // The simplest mention item: a label and a id
        new MentionItem(label: 'Banana', id: 1),
        
         // Add a href to make the mention clickable in the final HTML output
        new MentionItem(id: 1, label: 'Strawberry', href: 'https://filamentphp.com'),
        
        // Include additional data to be stored in the final JSON output
        new MentionItem(id: 1, label: 'Strawberry', data: ['type' => 'fruit_mentions']),
    ])
```

--------------------------------

### getMediaAction(): Action

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Resolves and returns the media action instance. It evaluates the stored action class name and falls back to the config key 'media_action' if not set.

```APIDOC
## getMediaAction(): Action

### Description
Resolves and returns the media action instance. It evaluates the stored action class name and falls back to the config key 'media_action' if not set.

### Method
getMediaAction

### Returns
- **Action** - The resolved action instance.

### Example
```php
$action = $editor->getMediaAction();
```
```

--------------------------------

### Create PHP parser for custom extension

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Create a PHP parser class for the custom extension, e.g., `app/TiptapExtensions/YourExtenion.php`. This is required for reading content from the database and rendering it in the editor or front end.

```php
namespace App\TiptapExtensions;

use Tiptap\Core\Node;

class Hero extends Node
{
    public static $name = 'hero';
    ...
}

```

--------------------------------

### Rebuild custom theme

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Rebuild your custom theme after making the configuration changes.

```sh
npm run build
```

--------------------------------

### Set output format to JSON with ->output()

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Sets the output format for a Tiptap editor instance to JSON. The output format determines how the editor content is stored in the database.

```php
use FilamentTiptapEditor\Enums\TiptapOutput;

TiptapEditor::make('content')
    ->output(FilamentTiptapEditor\TiptapOutput::Json);
```

--------------------------------

### TiptapFaker::asHTML()

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-faker.md

Returns the accumulated HTML output.

```APIDOC
## TiptapFaker::asHTML()

### Description
Returns the accumulated HTML output as a string.

### Method
`public function asHTML(): string`

### Parameters
None.

### Returns
- `string` - The accumulated HTML output.

### Example
```php
$html = $faker->asHTML();
```
```

--------------------------------

### TiptapFaker::details()

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-faker.md

Appends a details element to the output buffer.

```APIDOC
## TiptapFaker::details()

### Description
Appends a details element (`<details><summary>...</summary><div data-type="details-content"><p>...</p></div></details>`) to the output buffer.

### Method
`public function details(): static`

### Parameters
None.

### Returns
- `static` - The current instance for chaining.

### Example
```php
$faker->details();
```
```

--------------------------------

### App-wide Tiptap Editor defaults via configureUsing

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Sets global defaults for all TiptapEditor instances using configureUsing, collapsing the blocks panel and using the 'simple' profile.

```php
use FilamentTiptapEditor\TiptapEditor;

TiptapEditor::configureUsing(function (TiptapEditor $component) {
    $component
        ->collapseBlocksPanel()
        ->profile('simple');
});
```

--------------------------------

### Configure Vite for custom extensions

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Add the custom extension JS and CSS files to the `input` array in `vite.config.js` and run a build to generate the files.

```js
export default defineConfig({
    plugins: [
        laravel({
            input: [
                ...
                'resources/js/tiptap/extensions.js',
                'resources/css/tiptap/extensions.css',
            ],
            refresh: true,
        }),
    ],
});

```

--------------------------------

### Set modal width, slide over, and icon

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Customize modal width, use a slide over, and set an icon. Note: icons currently only show on the drag and drop block panel.

```php
class BatmanBlock extends TiptapBlock
{
    public string $width = 'xl';
    
    public bool $slideOver = true;
    
    public ?string $icon = 'heroicon-o-film';
}
```

--------------------------------

### getExtensionScripts method signature

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Returns the source values of all configured custom extensions (Vite asset paths), or [] when none are configured.

```php
public function getExtensionScripts(): array
```

--------------------------------

### getBlocks method signature

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Evaluates the blocks collection, resolving Closures and class strings with app(), instantiates each class, and maps them by identifier into an associative array.

```php
public function getBlocks(): array
```

--------------------------------

### Register custom extension on window.TiptapEditorExtensions

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/js-plugin.md

Registers a custom extension object in a keyed array on window.TiptapEditorExtensions before the plugin loads. The extension is imported from './hero.js' and associated with the 'hero' key.

```js
import Hero from "./hero.js";

window.TiptapEditorExtensions = {
    hero: [Hero],
};
```

--------------------------------

### getTools

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Returns the tool list, replacing matching tool identifiers with full extension config arrays.

```APIDOC
## getTools

### Description
Returns the instance's tool list. Any tool identifier matching an entry in `config('filament-tiptap-editor.extensions')` (matched by `id`) is replaced with the full extension config array `['id' => ..., 'name' => ..., 'button' => ..., 'parser' => ..., 'source' => ...]`.

### Method
`getTools(): array`

### Returns
- `array` - The tool list with extension configs substituted.
```

--------------------------------

### Hurdle methods

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/extensions-nodes.md

Renders a divider <div> with class 'filament-tiptap-hurdle' and a color attribute. Options include gray_light, gray, gray_dark, primary, secondary, tertiary, accent.

```php
public function addOptions(): array  // colors: gray_light|gray|gray_dark|primary|secondary|tertiary|accent
public function addAttributes(): array  // color default 'gray' → data-color
public function parseHTML(): array
public function renderHTML($node, $HTMLAttributes = []): array
```

--------------------------------

### TiptapConverter Facade Class Definition

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-converter.md

Defines the TiptapConverter facade with methods asHTML, asJSON, and asText. The getFacadeAccessor method returns 'tiptap-converter', the singleton key registered by the service provider.

```php
/**
 * @method static string asHTML(string|array $content)
 * @method static string asJSON(string|array $content, bool $decoded)
 * @method static string asText(string|array $content)
 *
 * @see \FilamentTiptapEditor\TiptapConverter
 */
class TiptapConverter extends Facade
{
    protected static function getFacadeAccessor(): string
    {
        return 'tiptap-converter';
    }
}
```

--------------------------------

### mentionItemsLoading(string | Closure | null $message): static

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Sets the text shown while mention suggestions are loading, replacing the default spinner.

```APIDOC
## mentionItemsLoading(string | Closure | null $message): static

### Description
Sets the text shown while mention suggestions are loading, replacing the default spinner.

### Method
mentionItemsLoading

### Parameters
- **$message** (string | Closure | null) - Required - The loading message.

### Returns
- **static** - The current instance for chaining.
```

--------------------------------

### Default profiles configuration

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/configuration.md

Defines the default profiles for the Tiptap editor: 'default', 'simple', 'minimal', and 'none'. Each profile lists toolbar tools and separators. Use this as a reference for customizing profiles via the 'profiles' config key or the 'profile()' instance method.

```php
'profiles' => [
    'default' => [
        'heading', 'bullet-list', 'ordered-list', 'checked-list', 'blockquote', 'hr', '|',
        'bold', 'italic', 'strike', 'underline', 'superscript', 'subscript', 'lead', 'small', 'color', 'align-left', 'align-center', 'align-right', '|',
        'link', 'media', 'oembed', 'table', 'grid-builder', 'details', '|', 'code', 'code-block', 'source', 'blocks',
    ],
    'simple' => ['heading', 'hr', 'bullet-list', 'ordered-list', 'checked-list', '|', 'bold', 'italic', 'lead', 'small', '|', 'link', 'media'],
    'minimal' => ['bold', 'italic', 'link', 'bullet-list', 'ordered-list'],
    'none' => [],
],
```

--------------------------------

### Show all placeholders with showOnlyCurrentPlaceholder(false)

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Controls whether placeholders are shown for all nodes simultaneously or only for the currently active node. Setting to false shows all placeholders at once.

```php
TiptapEditor::make('content')
    // All nodes will immediately be displayed, instead of only the selected node
    ->showOnlyCurrentPlaceholder(false)
```

--------------------------------

### gridLayouts / getGridLayouts

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Sets and retrieves the available grid layouts for the grid tool.

```APIDOC
## gridLayouts / getGridLayouts

### Description
Customizes the available grid layouts shown in the `grid` tool dropdown (defaults to the 12 layouts listed in the properties block above).

### Method
`gridLayouts(array $layouts): static`
`getGridLayouts(): array`

### Parameters
- `$layouts` (array) - Required - The grid layouts to set.

### Returns
- `static` for `gridLayouts`
- `array` for `getGridLayouts`
```

--------------------------------

### Tiptap Editor with JSON output, custom blocks, and merge tags

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Configures a TiptapEditor field with JSON output, custom block classes, collapsed blocks panel, merge tags, and a custom toolset. Includes a comment noting that blocks support is only active when output is JSON and 'blocks' is in tools.

```php
use FilamentTiptapEditor\TiptapEditor;
use FilamentTiptapEditor\Enums\TiptapOutput;
use App\TiptapBlocks\BatmanBlock;
use App\TiptapBlocks\StaticBlock;

TiptapEditor::make('content')
    ->output(TiptapOutput::Json)
    ->blocks([
        BatmanBlock::class,
        StaticBlock::class,
    ])
    ->collapseBlocksPanel()
    ->mergeTags(['first_name', 'last_name'])
    ->tools(['heading', 'blocks', '|', 'bold', 'italic', 'link'])
    // Guard against blocks support: only active when output is JSON and 'blocks' is in tools
    ->shouldSupportBlocks();
```

--------------------------------

### Import plugin CSS in theme

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Import the plugin's stylesheet into your custom theme's CSS file. Also import tippy.js stylesheet if not already included.

```css
@import '<path-to-vendor>/awcodes/filament-tiptap-editor/resources/css/plugin.css';
```

--------------------------------

### tippyPlacement(string|TippyPlacement|Closure $placement): static

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Sets the tippy.js toolbar placement. The placement value is used by getTippyPlacement().

```APIDOC
## tippyPlacement

### Description
Sets the tippy.js toolbar placement. The placement value is used by getTippyPlacement().

### Method
`tippyPlacement(string|TippyPlacement|Closure $placement): static`

### Parameters
- **$placement** (string|TippyPlacement|Closure) - Required - The placement for the tippy.js toolbar. See the TippyPlacement enum.

### Returns
- **static** - The current instance for chaining.

### Example
```php
use FilamentTiptapEditor\Enums\TippyPlacement;

TiptapEditor::make('content')->tippyPlacement(TippyPlacement::Left);
```
```

--------------------------------

### Set per-instance max content width with ->maxContentWidth()

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/README.md

Sets the maximum content width per editor instance using the `->maxContentWidth()` method. This overrides the global `max_content_width` config.

```php
use FilamentTiptapEditor\TiptapEditor;

TiptapEditor::make('content')
    ->maxContentWidth('3xl');
```

--------------------------------

### asTOC

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-converter.md

Generates a table of contents from Tiptap content. Can return a nested array or a string.

```APIDOC
## asTOC

### Description
Generates a table of contents from the given Tiptap content. Can return a nested array or a string representation.

### Method
`asTOC`

### Signature
```php
public static function asTOC(string|array $content, int $minDepth = 1, int $maxDepth = 6, bool $array = false): string|array
```

### Parameters
- **$content** (string|array) - Required - The Tiptap content to generate a table of contents from.
- **$minDepth** (int) - Optional - Minimum heading depth to include. Defaults to `1`.
- **$maxDepth** (int) - Optional - Maximum heading depth to include. Defaults to `6`.
- **$array** (bool) - Optional - If `true`, returns a nested array instead of a string. Defaults to `false`.

### Return Value
Returns the table of contents as a string (HTML) or a nested array if `$array` is `true`.

### Usage Example
```blade
{!! tiptap_converter()->asTOC($post->content, maxDepth: 3) !!}

<x-filament-tiptap-editor::table-of-contents
    :headings="tiptap_converter()->asTOC($page->body, minDepth: 2, maxDepth: 4, array: true)"
/>
```
```

--------------------------------

### minSize(int | Closure $size): static

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Sets the minimum file size for media uploads. The value is forwarded to the FileUpload component and stored in the 'min_file_size' configuration (in KB).

```APIDOC
## minSize(int | Closure $size): static

### Description
Sets the minimum file size for media uploads. The value is forwarded to the FileUpload component and stored in the 'min_file_size' configuration (in KB).

### Method
minSize

### Parameters
- **$size** (int | Closure) - Required - The minimum file size in kilobytes or a closure returning it.

### Returns
- **static** - The current instance for chaining.

### Example
```php
TiptapEditor::make('content')
    ->minSize(0);
```
```

--------------------------------

### Link extension addOptions and addAttributes methods

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/extensions-marks-globals.md

Shows the method signatures for the Link mark extension. The addOptions method merges parent options with defaults for openOnClick, linkOnPaste, autoLink, protocols, HTMLAttributes, and validate. The addAttributes method is declared but its body is not shown.

```php
public function addOptions(): array
// array_merge(parent::addOptions(), [
//     'openOnClick' => true,
//     'linkOnPaste' => true,
//     'autoLink' => true,
//     'protocols' => [],
//     'HTMLAttributes' => [],
//     'validate' => 'undefined',
// ])

public function addAttributes(): array
```

--------------------------------

### getGridBuilderAction(): Action

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/concerns.md

Resolves and returns the grid builder action instance. It evaluates the stored action class name and falls back to the config key 'grid_builder_action' if not set.

```APIDOC
## getGridBuilderAction(): Action

### Description
Resolves and returns the grid builder action instance. It evaluates the stored action class name and falls back to the config key 'grid_builder_action' if not set.

### Method
getGridBuilderAction

### Returns
- **Action** - The resolved action instance.

### Example
```php
$action = $editor->getGridBuilderAction();
```
```

--------------------------------

### gridLayouts and getGridLayouts method signatures

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-editor.md

Customizes the available grid layouts shown in the 'grid' tool dropdown (defaults to the 12 layouts listed in the properties block above).

```php
public function gridLayouts(array $layouts): static
public function getGridLayouts(): array
```

--------------------------------

### TiptapFaker::video()

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-faker.md

Appends a video embed wrapper to the output buffer.

```APIDOC
## TiptapFaker::video()

### Description
Appends a video embed wrapper (`<div data-vimeo-video="true">` or `<div data-youtube-video="true">`) containing an iframe to the output buffer. The provider can be 'youtube' or 'vimeo'.

### Method
`public function video(?string $provider = 'youtube', ?int $width = 1600, ?int $height = 900, bool $responsive = true): static`

### Parameters
- `$provider` (?string) - Optional - Video provider: 'youtube' or 'vimeo'. Defaults to 'youtube'.
- `$width` (?int) - Optional - Video width in pixels. Defaults to 1600.
- `$height` (?int) - Optional - Video height in pixels. Defaults to 900.
- `$responsive` (bool) - Optional - Whether to add responsive CSS (aspect-ratio style and a 'responsive' class). Defaults to true.

### Returns
- `static` - The current instance for chaining.

### Example
```php
$faker->video(provider: 'youtube', responsive: false);
```
```

--------------------------------

### getLabel method

Source: https://github.com/awcodes/filament-tiptap-editor/blob/3.x/_autodocs/api-reference/tiptap-block.md

Returns the block label, either the set label or the title-cased kebab-cased class basename.

```php
public function getLabel(): string
```
Tokens:
Raw