Tiptap for PHP

https://github.com/ueberdosis/tiptap-php
Admin
Tiptap for PHP is a package that converts between Tiptap-compatible JSON and HTML, sanitizes...
Tokens:36,644
Snippets:518
Trust Score:9.7
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Serialize Tiptap Document Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Full example showing schema initialization, document structure definition, and processing into HTML.

```php
$schema = new Schema([new StarterKit()]);
$serializer = new DOMSerializer($schema);

$doc = [
    'type' => 'doc',
    'content' => [
        [
            'type' => 'paragraph',
            'content' => [
                [
                    'type' => 'text',
                    'text' => 'Bold',
                    'marks' => [['type' => 'bold']]
                ]
            ]
        ]
    ]
];

echo $serializer->process($doc);
// Output: <p><strong>Bold</strong></p>
```

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

### ListItem Configuration

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Configuration example for initializing a ListItem node.

```php
new ListItem([
    'HTMLAttributes' => [],
])
```

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

### TaskItem Configuration

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Configuration example for initializing a TaskItem node.

```php
new TaskItem([
    'HTMLAttributes' => [],
])
```

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

### DOMParser Usage Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Example showing how to instantiate the parser and process an HTML string.

```php
$schema = new Schema([new StarterKit()]);
$parser = new DOMParser($schema);
$doc = $parser->process('<p>Hello <strong>World</strong></p>');

// Result:
// [
//     'type' => 'doc',
//     'content' => [
//         [
//             'type' => 'paragraph',
//             'content' => [
//                 [
//                     'type' => 'text',
//                     'text' => 'Hello ',
//                     'marks' => []
//                 ],
//                 [
//                     'type' => 'text',
//                     'text' => 'World',
//                     'marks' => [['type' => 'bold']]
//                 ]
//             ]
//         ]
//     ]
// ]
```

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

### Instantiate Extension with Options

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/02-extensions-core.md

Example of passing configuration options during extension instantiation.

```php
new StarterKit([
    'codeBlock' => false,
    'heading' => ['levels' => [1, 2, 3]],
])
```

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

### BulletList Configuration

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Configuration example for initializing a BulletList node.

```php
new BulletList([
    'HTMLAttributes' => [],
])
```

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

### Example: Retrieving Style Values

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/07-utilities.md

Usage example for fetching individual style property values.

```php
$color = InlineStyle::getAttribute($dom, 'color');
// Returns: 'red' or null

$size = InlineStyle::getAttribute($dom, 'font-size');
// Returns: '14px' or null
```

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

### OrderedList Configuration

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Configuration example for initializing an OrderedList node.

```php
new OrderedList([
    'HTMLAttributes' => [],
])
```

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

### JSONSerializer Usage Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Example of initializing the serializer and processing a document.

```php
$serializer = new JSONSerializer();
$json = $serializer->process($document);
// Returns: '{"type":"doc","content":[...]}'
```

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

### Use CodeBlockHighlight in Editor

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Example of initializing the editor with CodeBlockHighlight and rendering content.

```php
$editor = new Editor([
    'extensions' => [
        new StarterKit(['codeBlock' => false]),
        new CodeBlockHighlight(),
    ],
]);

$editor->setContent('<pre><code><?php phpinfo()</code></pre>')
    ->getHTML();

// Output includes highlighted HTML:
// <pre><code class="hljs php"><span class="hljs-meta"><?php</span> ...</code></pre>
```

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

### TaskList Usage Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Example of setting JSON content for a task list and retrieving the rendered HTML.

```php
$editor->setContent([
    'type' => 'doc',
    'content' => [
        [
            'type' => 'taskList',
            'content' => [
                [
                    'type' => 'taskItem',
                    'attrs' => ['checked' => true],
                    'content' => [
                        ['type' => 'paragraph', 'content' => [
                            ['type' => 'text', 'text' => 'Done task']
                        ]]
                    ]
                ]
            ]
        ]
    ]
])->getHTML();

// Output: <ul><li data-type="taskItem"><label><input type="checkbox" checked="checked"><span></span></label><div>...</div></li></ul>
```

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

### List Node Usage Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Examples of setting content for bullet and ordered lists and retrieving the HTML output.

```php
$editor->setContent('<ul><li>Item 1</li><li>Item 2</li></ul>')
    ->getHTML();
// Output: <ul><li>Item 1</li><li>Item 2</li></ul>

$editor->setContent('<ol start="5"><li>Fifth</li><li>Sixth</li></ol>')
    ->getHTML();
// Output: <ol start="5"><li>Fifth</li><li>Sixth</li></ol>
```

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

### Use CodeBlockShiki in Editor

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Example of initializing the editor with CodeBlockShiki and rendering content.

```php
$editor = new Editor([
    'extensions' => [
        new StarterKit(['codeBlock' => false]),
        new CodeBlockShiki([
            'theme' => 'github-dark',
            'defaultLanguage' => 'php',
        ]),
    ],
]);

$editor->setContent('<pre><code><?php echo "Hello"; ?></code></pre>')
    ->getHTML();
```

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

### Install Tiptap PHP

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/00-index.md

Use Composer to add the library to your project.

```bash
composer require ueberdosis/tiptap-php
```

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

### TextAlign Usage Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/05-extensions-specialized.md

Example showing how to register the extension and how it handles default alignment values during HTML output.

```php
$editor = new Editor([
    'extensions' => [
        new StarterKit(),
        new TextAlign([
            'types' => ['paragraph', 'heading'],
            'alignments' => ['left', 'center', 'right'],
            'defaultAlignment' => 'left',
        ]),
    ],
]);

$editor->setContent(
    '<p style="text-align: center;">Centered</p>'
)->getHTML();
// Output: <p style="text-align: center;">Centered</p>

$editor->setContent(
    '<p style="text-align: left;">Default</p>'
)->getHTML();
// Output: <p>Default</p> (default alignment omitted)
```

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

### StarterKit Usage Examples

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/05-extensions-specialized.md

Demonstrates initializing the editor with default settings, disabling specific components, configuring node options, and creating a custom extension stack.

```php
// Default: all components enabled
$editor = new Editor();

// Disable code blocks and strikes
$editor = new Editor([
    'extensions' => [
        new StarterKit([
            'codeBlock' => false,
            'strike' => false,
        ]),
    ],
]);

// Configure heading levels
$editor = new Editor([
    'extensions' => [
        new StarterKit([
            'heading' => [
                'levels' => [1, 2],
                'HTMLAttributes' => ['class' => 'heading'],
            ],
        ]),
    ],
]);

// Completely custom setup
$editor = new Editor([
    'extensions' => [
        new Paragraph(),
        new Text(),
        new Bold(),
        new Italic(),
        new Link(),
    ],
]);
```

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

### Example: Extracting Inline Styles

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/07-utilities.md

Usage example for extracting styles from a DOMElement.

```php
// Assuming $dom is a DOMElement with style="color: red; font-size: 14px;"
$styles = InlineStyle::get($dom);

// Result:
// [
//     'color' => 'red',
//     'font-size' => '14px'
// ]
```

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

### Configure Image

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Configuration example for the Image node with custom HTML attributes.

```php
new Image([
    'HTMLAttributes' => ['class' => 'img'],
])
```

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

### RenderInstruction examples

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/08-types.md

Common patterns for defining render instructions including nesting and direct content.

```php
// Simple tag
['p', 0]

// Tag with attributes
['p', ['class' => 'text'], 0]

// Nested tags
['table', ['tbody', 0]]

// Complex nesting
['pre', ['code', ['class' => 'language-php'], 0]]

// Direct content
['content' => '<pre><code>...</code></pre>']

// Null (omit)
null
```

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

### Configure HardBreak

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Configuration example for the HardBreak node.

```php
new HardBreak([
    'HTMLAttributes' => [],
])
```

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

### TextSerializer Usage Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Example of configuring and using the TextSerializer to convert a document to plain text.

```php
$config = ['blockSeparator' => "\n"];
$serializer = new TextSerializer($schema, $config);

$doc = [
    'type' => 'doc',
    'content' => [
        [
            'type' => 'heading',
            'content' => [['type' => 'text', 'text' => 'Title']]
        ],
        [
            'type' => 'paragraph',
            'content' => [['type' => 'text', 'text' => 'Body']]
        ]
    ]
];

echo $serializer->process($doc);
// Output:
// Title
// Body

// With blockSeparator = "\n\n":
// Title
//
// Body
```

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

### Install Shiki npm package

Source: https://github.com/ueberdosis/tiptap-php/blob/main/README.md

Install the Shiki npm package to enable syntax highlighting for code blocks. This is a prerequisite for using the CodeBlockShiki extension.

```bash
npm install shiki
```

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

### Basic CodeBlockShiki Extension Setup

Source: https://github.com/ueberdosis/tiptap-php/blob/main/README.md

Configure the Tiptap editor to use the CodeBlockShiki extension for syntax highlighting. Ensure StarterKit's codeBlock is disabled to avoid conflicts.

```php
(new \Tiptap\Editor([
    'extensions' => [
        new \Tiptap\Extensions\StarterKit([
            'codeBlock' => false,
        ]),
        new \Tiptap\Nodes\CodeBlockShiki(),
    ],
]))
->setContent('<pre><code>&lt;?php phpinfo()</code></pre>')
->getHTML();
```

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

### Usage Example for Blockquote Node

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Demonstrates rendering blockquote content.

```php
$editor->setContent('<blockquote><p>Quoted text</p></blockquote>')
    ->getHTML();
// Output: <blockquote><p>Quoted text</p></blockquote>
```

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

### Configure HorizontalRule

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Configuration example for the HorizontalRule node.

```php
new HorizontalRule([
    'HTMLAttributes' => [],
])
```

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

### Underline Configuration

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Example of initializing the Underline mark with custom HTML attributes.

```php
new Underline([
    'HTMLAttributes' => [],
])
```

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

### Configure Heading Node

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Example of initializing the Heading node with specific levels and HTML attributes.

```php
new Heading([
    'levels' => [1, 2, 3],
    'HTMLAttributes' => ['class' => 'title'],
])
```

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

### Table Node Usage Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Demonstrates setting table HTML content and retrieving the rendered output.

```php
$editor->setContent('<table><tr><th>Header</th></tr><tr><td>Cell</td></tr></table>')
    ->getHTML();
// Output: <table><tbody><tr><th>Header</th></tr><tr><td>Cell</td></tr></tbody></table>
```

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

### Define Mark Type Examples

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/08-types.md

Examples of various mark types including simple marks and those requiring attributes.

```php
[
    'type' => 'bold'
]
```

```php
[
    'type' => 'italic'
]
```

```php
[
    'type' => 'code'
]
```

```php
[
    'type' => 'link',
    'attrs' => [
        'href' => string,    // URL
        'target' => string,  // optional, e.g., '_blank'
        'rel' => string,     // optional, e.g., 'noopener noreferrer'
        'class' => string    // optional, CSS class
    ]
]
```

```php
[
    'type' => 'highlight',
    'attrs' => [
        'color' => string  // optional, hex/rgb color (if multicolor enabled)
    ]
]
```

```php
[
    'type' => 'mention',
    'attrs' => [
        'id' => string  // Mention identifier
    ]
]
```

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

### Underline Usage Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Demonstrates setting content with an underline tag and retrieving the HTML.

```php
$editor->setContent('<p><u>Underlined</u></p>')->getHTML();
// Output: <p><u>Underlined</u></p>
```

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

### Configure Paragraph Node

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Example of initializing a Paragraph node with custom HTML attributes.

```php
new Paragraph([
    'HTMLAttributes' => ['class' => 'custom-paragraph'],
])
```

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

### Usage Example for Heading Node

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Demonstrates setting content with headings and how the editor handles restricted levels.

```php
$editor = new Editor([
    'extensions' => [
        new Heading(['levels' => [1, 2]]),
    ],
]);

$editor->setContent('<h1>Title</h1><h2>Subtitle</h2>')->getHTML();
// Renders: <h1>Title</h1><h2>Subtitle</h2>

// h3+ converted to h1 (first allowed level)
$editor->setContent('<h3>Text</h3>')->getHTML();
// Output: <h1>Text</h1>
```

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

### Configure CodeBlock Node

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Example of initializing the CodeBlock node with custom language class prefix.

```php
new CodeBlock([
    'languageClassPrefix' => 'language-',
    'HTMLAttributes' => [],
])
```

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

### Link Usage and Security Examples

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Demonstrates basic link rendering and the use of custom URI validation to restrict allowed domains.

```php
$editor->setContent('<a href="https://example.com">Link</a>')
    ->getHTML();
// Output: <a href="https://example.com" target="_blank" rel="noopener noreferrer nofollow">Link</a>

// With custom validation
$editor = new Editor([
    'extensions' => [
        new Link([
            'isAllowedUri' => function($uri) {
                // Only allow your domain
                return preg_match('/^https:\/\/mydomain\.com/', $uri);
            },
        ]),
    ],
]);

$editor->setContent('<a href="https://example.com">External</a>')
    ->getHTML();
// Output: <a href="" target="_blank" rel="noopener noreferrer nofollow">External</a>
// (href removed because not allowed)
```

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

### Style Matching Rules

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Examples of style-based matching rules for the parser.

```php
['style' => 'color']                // Has any color style
['style' => 'font-weight=bold']     // Has specific style value
```

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

### Use Color Extension in Editor

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/05-extensions-specialized.md

Example of initializing the editor with the Color extension and processing HTML content.

```php
$editor = new Editor([
    'extensions' => [
        new Paragraph(),
        new Color(['types' => ['paragraph']]),
    ],
]);

$editor->setContent(
    '<p style="color: #ff0000;">Red text</p>'
)->getHTML();
// Output: <p style="color: #ff0000;">Red text</p>
```

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

### Use Mention Node in Editor

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Example of initializing the editor with a custom renderLabel callback for mentions.

```php
$editor = new Editor([
    'extensions' => [
        new Mention([
            'renderLabel' => fn($node) => $this->getUserName($node->attrs->id),
        ]),
    ],
]);

$editor->setContent('<span data-type="mention" data-id="123">@Alice</span>')
    ->getText();
```

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

### Configure Blockquote Node

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Example of initializing the Blockquote node with custom HTML attributes.

```php
new Blockquote([
    'HTMLAttributes' => ['class' => 'quote'],
])
```

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

### Example: Checking Inline Styles

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/07-utilities.md

Demonstrates checking for property existence or specific key-value pairs.

```php
// Property exists (any value)
InlineStyle::hasAttribute($dom, 'color');
// true if style includes "color: ...;"

// Check specific value
InlineStyle::hasAttribute($dom, ['color' => 'red']);
// true if style includes "color: red;"

// Multiple properties
InlineStyle::hasAttribute($dom, [
    'color' => 'red',
    'font-weight' => 'bold'
]);
// true only if both properties match
```

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

### Tag Matching Rules

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Examples of tag-based matching rules for the parser.

```php
['tag' => 'p']                      // Match <p> elements
['tag' => 'h1']                     // Match <h1>
['tag' => 'a[href]']                // Match <a> with href
['tag' => 'span[data-id="123"]']    // Match with specific attribute
```

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

### Use Highlight in Editor

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Examples of using the Highlight mark in both single-color and multi-color modes.

```php
// Simple highlight (single color)
$editor = new Editor([
    'extensions' => [new Highlight(['multicolor' => false])],
]);

$editor->setContent('<mark>Highlighted</mark>')
    ->getHTML();
// Output: <mark>Highlighted</mark>

// Multi-color highlight
$editor = new Editor([
    'extensions' => [new Highlight(['multicolor' => true])],
]);

$editor->setContent([
    'type' => 'doc',
    'content' => [
        [
            'type' => 'paragraph',
            'content' => [
                [
                    'type' => 'text',
                    'text' => 'Yellow text',
                    'marks' => [
                        [
                            'type' => 'highlight',
                            'attrs' => ['color' => '#ffff00'],
                        ]
                    ]
                ]
            ]
        ]
    ]
])->getHTML();

// Output: <p><mark data-color="#ffff00" style="background-color: #ffff00;">Yellow text</mark></p>
```

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

### Parse Bold Mark

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Examples of parsing HTML input into Bold marks.

```php
$editor->setContent('<p><strong>Bold text</strong></p>')->getHTML();
// Output: <p><strong>Bold text</strong></p>

$editor->setContent('<p><b style="font-weight: 700;">Bold</b></p>')->getHTML();
// Output: <p><strong>Bold</strong></p>
```

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

### Minify HTML Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/07-utilities.md

Demonstrates how to use the Minify class to process HTML content while preserving pre-formatted blocks.

```php
$minifier = new Minify();

$html = <<<HTML
<div>
    <p>
        Hello    World
    </p>
    <pre>
        code block
        with spaces
    </pre>
</div>
HTML;

$minified = $minifier->process($html);

// Result: <div><p>Hello    World</p><pre>
//        code block
//        with spaces
//    </pre></div>
// (whitespace around blocks removed, pre content preserved)
```

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

### Usage Example for CodeBlock Node

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Demonstrates setting JSON content for a code block and its resulting HTML output.

```php
$editor->setContent([
    'type' => 'doc',
    'content' => [
        [
            'type' => 'codeBlock',
            'attrs' => ['language' => 'php'],
            'content' => [
                ['type' => 'text', 'text' => '<?php echo "Hello";']
            ]
        ]
    ]
])->getHTML();

// Output:
// <pre><code class="language-php"><?php echo "Hello";</code></pre>
```

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

### Apply Schema Rules

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Method signature and usage example for applying schema rules to a document.

```php
public function apply(array $document): array
```

```php
$schema = new Schema([$extensions]);
$cleanDoc = $schema->apply($document);
```

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

### Link Configuration

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Example of configuring the Link mark with custom attributes, allowed protocols, and a custom URI validation callback.

```php
new Link([
    'HTMLAttributes' => [
        'target' => '_blank',
        'rel' => 'noopener noreferrer nofollow',
    ],
    'allowedProtocols' => [
        'http', 'https', 'ftp', 'ftps', 'mailto', 'tel', 'callto', 'sms', 'cid', 'xmpp',
    ],
    'isAllowedUri' => fn($uri) => ...,  // Custom validation
])
```

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

### Handle Empty Content

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/08-types.md

Examples of empty content arrays and text nodes without marks.

```php
// Valid (block with no content):
['type' => 'paragraph', 'content' => []]

// Renders as:
// <p></p>

// Text with no marks:
['type' => 'text', 'text' => 'Hello']  // marks omitted
['type' => 'text', 'text' => 'Hello', 'marks' => []]  // Same
```

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

### Retrieve Attribute Configurations

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Method signature and usage example for merging global and class-specific attributes.

```php
public function getAttributeConfigurations($class): array
```

```php
$config = $schema->getAttributeConfigurations($boldMark);
// Returns attributes from Color, FontFamily, TextAlign + Bold's own attributes
```

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

### Render Image Node

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Example of setting content containing an image node and retrieving the HTML output.

```php
$editor->setContent([
    'type' => 'doc',
    'content' => [
        [
            'type' => 'paragraph',
            'content' => [
                [
                    'type' => 'image',
                    'attrs' => [
                        'src' => 'https://example.com/image.jpg',
                        'alt' => 'Example',
                        'title' => 'An image',
                    ]
                ]
            ]
        ]
    ]
])->getHTML();

// Output: <p><img src="..." alt="Example" title="An image"></p>
```

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

### Define Style Property Selectors

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/08-types.md

Examples of style selectors for matching CSS properties during parsing.

```php
'style' => 'color'                 // Match any color style
'style' => 'font-weight=bold'      // Match specific style value
'style' => 'text-align'            // Match text-align property
```

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

### Paragraph Usage Example

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Demonstrates using the Paragraph node within an Editor instance to render HTML.

```php
$editor = new Editor([
    'extensions' => [
        new Paragraph([
            'HTMLAttributes' => ['class' => 'text'],
        ]),
    ],
]);

$editor->setContent('<p class="text">Hello</p>')->getHTML();
// Output: <p class="text">Hello</p>
```

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

### Define Tag Selectors

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/08-types.md

Examples of tag selectors for matching HTML elements during parsing.

```php
'tag' => 'p'                        // Match <p>
'tag' => 'h[1-6]'                  // Conceptual (requires manual loop)
'tag' => 'a[href]'                 // Match <a> with href attribute
'tag' => 'span[data-type="mention"]' // Match with specific attribute value
```

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

### Use FontFamily Extension in Editor

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/05-extensions-specialized.md

Example of initializing the editor with the FontFamily extension and processing HTML content.

```php
$editor = new Editor([
    'extensions' => [
        new Paragraph(),
        new FontFamily(['types' => ['paragraph']]),
    ],
]);

$editor->setContent(
    '<p style="font-family: \'Courier New\', monospace;">Code font</p>'
)->getHTML();
// Output: <p style="font-family: 'Courier New', monospace;">Code font</p>
```

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

### Initialize Editor with Content and Extensions

Source: https://github.com/ueberdosis/tiptap-php/blob/main/README.md

Create a new Tiptap editor instance, providing initial content and a custom array of extensions. StarterKit is loaded by default if not specified.

```php
new \Tiptap\Editor([
    'content' => '<p>Example Text</p>',
    'extensions' => [
        new \Tiptap\Extensions\StarterKit,
    ],
])
```

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

### Define HTML Serialization

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/02-extensions-core.md

Method signature and implementation example for rendering marks back to HTML.

```php
public function renderHTML($mark, $HTMLAttributes = []): ?array
```

```php
public function renderHTML($mark, $HTMLAttributes = [])
{
    return ['strong', $HTMLAttributes, 0];
}
```

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

### Define Mark Attributes

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/02-extensions-core.md

Method signature and implementation example for defining mark-specific attributes.

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

```php
public function addAttributes()
{
    return [
        'href' => [
            'parseHTML' => fn($node) => $node->getAttribute('href'),
        ],
        'title' => [
            'default' => null,
        ],
    ];
}
```

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

### Define HTML Matching Rules

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/02-extensions-core.md

Method signature and implementation example for defining how HTML is parsed into marks.

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

```php
public function parseHTML()
{
    return [
        ['tag' => 'strong'],
        ['tag' => 'b'],
        ['style' => 'font-weight', 'getAttrs' => fn($val) => preg_match('/bold|[5-9]/', $val) ? null : false],
    ];
}
```

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

### StarterKit Configuration

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Demonstrates how to disable specific marks or provide custom configuration arrays when initializing the StarterKit.

```APIDOC
## StarterKit Configuration

### Description
Configure the StarterKit by passing an array of marks. Set a mark to `false` to disable it, or provide an array of configuration options to customize its behavior.

### Usage
```php
new StarterKit([
    'bold' => false,       // Disable bold
    'italic' => [],        // Enable with defaults
    'code' => [            // Configure code mark
        'HTMLAttributes' => ['class' => 'inline-code'],
    ],
])
```
```

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

### InlineStyle parsing methods

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/07-utilities.md

Examples of retrieving and validating CSS properties from a DOM style string.

```php
InlineStyle::get($dom) // style="color: red; font-size: 14px;"
// Returns: ['color' => 'red', 'font-size' => '14px']

InlineStyle::getAttribute($dom, 'color')
// Returns: 'red'

InlineStyle::hasAttribute($dom, 'font-weight')
// Returns: false (property not present)

InlineStyle::hasAttribute($dom, ['color' => 'red', 'font-size' => '14px'])
// Returns: true (both match)
```

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

### StarterKit::__construct

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/05-extensions-specialized.md

Initializes the StarterKit extension with optional configurations for included nodes and marks.

```APIDOC
## StarterKit::__construct

### Description
Initializes the StarterKit extension. You can pass an array of options to configure or disable specific nodes and marks.

### Signature
`new StarterKit(array $options)`

### Parameters
- **options** (array) - Optional - An associative array where keys are component names (e.g., 'blockquote', 'bold') and values are either an array of configuration options or `false` to disable the component.

### Example
```php
new StarterKit([
    'codeBlock' => false,
    'heading' => [
        'levels' => [1, 2],
        'HTMLAttributes' => ['class' => 'heading'],
    ],
]);
```
```

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

### Configure StarterKit Extension

Source: https://github.com/ueberdosis/tiptap-php/blob/main/README.md

Configure the StarterKit extension, similar to the JavaScript package, by passing an array with specific extension configurations.

```php
new \Tiptap\Editor([
    'extensions' => [
        new Tiptap\Extensions\StarterKit([
            'codeBlock' => false,
            'heading' => [
                'HTMLAttributes' => [
                    'class' => 'my-custom-class',
                ],
            ]
        ]),
    ],
])
```

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

### Run Tests Continuously

Source: https://github.com/ueberdosis/tiptap-php/blob/main/README.md

Keep the test suite running and watch for file changes by installing and using nodemon.

```bash
composer test-watch
```

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

### Create Custom Node Extension

Source: https://github.com/ueberdosis/tiptap-php/blob/main/README.md

Build a custom Node extension by extending the base Node class. This example defines a 'customNode' with custom parsing and rendering logic.

```php
<?php

use Tiptap\Core\Node;

class CustomNode extends Node
{
    public static $name = 'customNode';
    
    public static $priority = 100;

    public function addOptions()
    {
        return [
            'HTMLAttributes' => [],
        ];
    }

    public function parseHTML()
    {
        return [
            [
                'tag' => 'my-custom-tag[data-id]',
            ],
            [
                'tag' => 'my-custom-tag',
                'getAttrs' => function ($DOMNode) {
                    return ! \Tiptap\Utils\InlineStyle::hasAttribute($DOMNode, [
                        'background-color' => '#000000',
                    ]) ? null : false;
                },
            ],
            [
                'style' => 'background-color',
                'getAttrs' => function ($value) {
                    return (bool) preg_match('/^(black)$/', $value) ? null : false;
                },
            ],
        ];
    }

    public function renderHTML($node)
    {
        return ['my-custom-tag', ['class' => 'foobar'], 0]
    }
}
```

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

### Define Full Document Structure

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/00-index.md

Example of a nested document structure containing a heading with marks and a paragraph.

```php
[
    'type' => 'doc',
    'content' => [
        [
            'type' => 'heading',
            'attrs' => ['level' => 1],
            'content' => [
                [
                    'type' => 'text',
                    'text' => 'Title',
                    'marks' => [['type' => 'bold']]
                ]
            ]
        ],
        [
            'type' => 'paragraph',
            'content' => [
                ['type' => 'text', 'text' => 'Paragraph text']
            ]
        ]
    ]
]
```

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

### Extension Constructor

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/02-extensions-core.md

Initializes an extension with optional configuration settings.

```php
public function __construct(array $options = [])
```

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

### Initialize Editor with Custom Extensions

Source: https://github.com/ueberdosis/tiptap-php/blob/main/README.md

Instantiate the Tiptap editor with a specific list of extensions, including StarterKit and custom marks like Link.

```php
new \Tiptap\Editor([
    'extensions' => [
        new \Tiptap\Extensions\StarterKit,
        new \Tiptap\Marks\Link,
    ],
])
```

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

### Configure or Disable Extensions

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/05-extensions-specialized.md

Demonstrates how to disable an extension, use default settings, or provide custom configuration within StarterKit.

```php
new StarterKit([
    'codeBlock' => false,    // Disable completely
    'codeBlock' => [],       // Use default configuration
    'codeBlock' => [         // Custom configuration
        'languageClassPrefix' => 'lang-',
    ],
])
```

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

### StarterKit Configuration Options

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/05-extensions-specialized.md

Available configuration keys for the StarterKit constructor. Pass false to disable a specific node or mark.

```php
new StarterKit([
    'document' => [],           // Document node options
    'blockquote' => [],         // Blockquote node options
    'bulletList' => [],         // BulletList node options
    'codeBlock' => [],          // CodeBlock node options
    'hardBreak' => [],          // HardBreak node options
    'heading' => [],            // Heading node options
    'horizontalRule' => [],     // HorizontalRule node options
    'listItem' => [],           // ListItem node options
    'orderedList' => [],        // OrderedList node options
    'paragraph' => [],          // Paragraph node options
    'text' => [],               // Text node options
    'bold' => [],               // Bold mark options
    'code' => [],               // Code mark options
    'italic' => [],             // Italic mark options
    'strike' => [],             // Strike mark options
])
```

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

### StarterKit Configuration

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/00-index.md

Configures the StarterKit extension with specific options for nodes and marks.

```APIDOC
## StarterKit Configuration

### Description
Configures the StarterKit, which includes a collection of standard nodes and marks. You can enable, disable, or customize specific nodes like 'document', 'paragraph', or 'heading'.

### Constructor
`new StarterKit(array $options)`

### Parameters
- **document** (boolean) - Optional - Set to false to disable the document node.
- **paragraph** (array) - Optional - Configuration for the paragraph node.
- **heading** (array) - Optional - Configuration for the heading node, such as 'levels'.
```

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

### Initializing the Editor

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/01-editor.md

Use the constructor to define initial content and configure extensions.

```php
new Editor([
    'content' => '<p>Initial content</p>',
    'extensions' => [
        new \Tiptap\Extensions\StarterKit([
            'codeBlock' => false, // Disable code blocks
        ]),
        new \Tiptap\Marks\Link(),
    ],
])
```

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

### Parse Italic Mark

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Example of parsing HTML input into Italic marks.

```php
$editor->setContent('<p><em>Italic text</em></p>')->getHTML();
// Output: <p><em>Italic text</em></p>
```

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

### Parse Inline Styles

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/08-types.md

Example of how inline styles are parsed into an associative array.

```php
// From: <div style="color: red; font-size: 14px;">
// Parsed as:
[
    'color' => 'red',
    'font-size' => '14px'
]
```

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

### Tiptap with CodeBlockHighlight for Syntax Highlighting

Source: https://github.com/ueberdosis/tiptap-php/blob/main/README.md

Integrate the CodeBlockHighlight extension with StarterKit to enable syntax highlighting in code blocks. Requires loading a CSS file for styling.

```php
(new \Tiptap\Editor([
    'extensions' => [
        new \Tiptap\Extensions\StarterKit([
            'codeBlock' => false,
        ]),
        new \Tiptap\Nodes\CodeBlockHighlight(),
    ],
]))
->setContent('<pre><code>&lt;?php phpinfo()</code></pre>')
->getHTML();
```

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

### Get Document Representation

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/01-editor.md

Retrieves the internal document structure as a PHP array.

```php
$editor->setContent('<p>Example</p>');
$doc = $editor->getDocument();
// Returns: ['type' => 'doc', 'content' => [['type' => 'paragraph', ...]]]
```

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

### Configure StarterKit

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/00-index.md

Options for customizing or disabling specific nodes and marks within the StarterKit.

```php
new StarterKit([
    'document' => false,              // Set false to disable
    'paragraph' => [],                // Set [] for defaults
    'heading' => ['levels' => [1,2]], // Pass config
    // ... all standard nodes/marks
])
```

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

### Configure StarterKit marks

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Pass false to disable a mark or an array to provide custom configuration such as HTML attributes.

```php
new StarterKit([
    'bold' => false,       // Disable bold
    'italic' => [],        // Enable with defaults
    'code' => [            // Configure code mark
        'HTMLAttributes' => ['class' => 'inline-code'],
    ],
])
```

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

### Get Inline Styles

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/07-utilities.md

Method signature for extracting all inline styles from a DOM element.

```php
public static function get($DOMNode): array
```

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

### Initialize Editor Instance

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/01-editor.md

Instantiate the Editor class with a custom configuration array, including specific extensions.

```php
use Tiptap\Editor;
use Tiptap\Extensions\StarterKit;

$editor = new Editor([
    'extensions' => [
        new StarterKit(),
    ],
]);
```

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

### Common Exception Types

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/00-index.md

Examples of standard exceptions thrown during content parsing or rendering failures.

```php
// Unknown content format
throw new Exception('Unknown format passed to setContent()...');

// Invalid render instruction (internal)
throw new Exception('[renderOpeningTag] Failed to use renderHTML...');
```

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

### Initialize Schema Constructor

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Constructor signature for creating a schema instance with an array of extensions.

```php
public function __construct(array $extensions = [])
```

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

### Configure Highlight mark

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Initialize the Highlight extension with specific options.

```php
new Highlight([
    'multicolor' => false,
    'HTMLAttributes' => [],
])
```

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

### Custom Matching Rule

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Example of a custom matching rule using a callback to extract attributes.

```php
['tag' => 'div', 'getAttrs' => fn($node) =>
    $node->getAttribute('class') === 'quote' ? ['cite' => $node->getAttribute('data-cite')] : false
]
```

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

### Run Tests

Source: https://github.com/ueberdosis/tiptap-php/blob/main/README.md

Execute the project's test suite using Composer.

```bash
composer test
```

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

### Define Editor Configuration

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/08-types.md

Structure for initializing the editor with content and a list of extensions.

```php
[
    'content' => string|array|null,    // Initial content
    'extensions' => Extension[]        // Array of extensions to use
]
```

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

### Get Specific Style Attribute

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/07-utilities.md

Method signature for retrieving the value of a specific style property.

```php
public static function getAttribute($DOMNode, $attribute): ?string
```

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

### Initialize DOMParser

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Constructor requiring a Schema instance.

```php
public function __construct(Schema $schema)
```

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

### StarterKit Class Definition

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/05-extensions-specialized.md

The base class definition for the StarterKit extension.

```php
class StarterKit extends Extension
```

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

### Implement document versioning

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/09-patterns-examples.md

Demonstrates a basic structure for saving document content and tracking changes in a separate history table.

```php
class DocumentStore {
    public function save(string $id, array $document): void {
        // Store current
        $this->db->insert('documents', [
            'id' => $id,
            'content' => json_encode($document),
            'created_at' => now(),
        ]);

        // Track changes
        $hash = md5(json_encode($document));
        $this->db->insert('document_history', [
            'document_id' => $id,
            'hash' => $hash,
            'timestamp' => now(),
        ]);
    }

    public function getVersion(string $id, int $version): array {
        return json_decode($this->db->get('documents', $id), true);
    }
}
```

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

### Enable Styling Options

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/09-patterns-examples.md

Adds support for color, font family, and text alignment extensions.

```php
$editor = new Editor([
    'extensions' => [
        new StarterKit(),
        new Color(['types' => ['textStyle']]),
        new FontFamily(['types' => ['textStyle']]),
        new TextAlign([
            'types' => ['paragraph', 'heading'],
            'alignments' => ['left', 'center', 'right'],
        ]),
    ],
]);
```

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

### Project File Structure

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/00-index.md

Visual representation of the source directory layout for the Tiptap PHP library.

```text
src/
├── Editor.php                    # Main API
├── Core/
│   ├── Extension.php            # Base class
│   ├── Node.php                 # Node base
│   ├── Mark.php                 # Mark base
│   ├── Schema.php               # Extension manager
│   ├── DOMParser.php            # HTML → Document
│   ├── DOMSerializer.php        # Document → HTML
│   ├── JSONSerializer.php       # Document → JSON
│   └── TextSerializer.php       # Document → Text
├── Nodes/                       # 28 node types
├── Marks/                       # 8 mark types
├── Extensions/                  # Utility extensions
└── Utils/
    ├── HTML.php                 # Attribute utilities
    ├── InlineStyle.php          # Style parsing
    └── Minify.php               # HTML minification
```

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

### Nest Marks in Content

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/04-marks-reference.md

Example of applying multiple marks to a text node, which the serializer handles by nesting tags.

```php
$editor->setContent([
    'type' => 'doc',
    'content' => [
        [
            'type' => 'paragraph',
            'content' => [
                [
                    'type' => 'text',
                    'text' => 'Bold italic code',
                    'marks' => [
                        ['type' => 'bold'],
                        ['type' => 'italic'],
                        ['type' => 'code'],
                    ]
                ]
            ]
        ]
    ]
])->getHTML();

// Output: <p><strong><em><code>Bold italic code</code></em></strong></p>
```

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

### Editor Constructor

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/01-editor.md

Initializes a new Tiptap Editor instance with specific content and extensions.

```APIDOC
## Editor Constructor

### Description
Initializes the Tiptap editor with a configuration array containing content and extensions.

### Parameters
- **configuration** (array) - Required - Configuration array with keys: 'content' (string|array) and 'extensions' (array).

### Request Example
```php
new Editor([
    'content' => '<p>Initial content</p>',
    'extensions' => [
        new \Tiptap\Extensions\StarterKit([
            'codeBlock' => false,
        ]),
        new \Tiptap\Marks\Link(),
    ],
])
```
```

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

### TextAlign Configuration

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/05-extensions-specialized.md

Configuration options for initializing the TextAlign extension.

```php
new TextAlign([
    'types' => ['paragraph', 'heading'],  // Node types to attach alignment to
    'alignments' => ['left', 'center', 'right', 'justify'],
    'defaultAlignment' => 'left',
])
```

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

### Load Editor Extensions

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/00-index.md

Initializes the editor instance with a specified array of extensions.

```php
new Editor(['extensions' => [
    new StarterKit(),
    new CodeBlockHighlight(),
    new Link(),
]]);
```

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

### Implement Selective Extension Loading

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/09-patterns-examples.md

Dynamically initializes the Editor with only the necessary extensions based on a feature string. Reduces overhead by avoiding the instantiation of unused extensions.

```php
class SmartEditor {
    public function createEditor(string $requiredFeatures): Editor {
        $extensions = [new StarterKit()];

        if (str_contains($requiredFeatures, 'code')) {
            $extensions[] = new CodeBlockHighlight();
        }

        if (str_contains($requiredFeatures, 'color')) {
            $extensions[] = new Color(['types' => ['textStyle']]);
        }

        if (str_contains($requiredFeatures, 'link')) {
            $extensions[] = new Link();
        }

        return new Editor(['extensions' => $extensions]);
    }
}
```

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

### Customize Editor Output

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/00-index.md

Configure extensions and HTML attributes during Editor initialization.

```php
new Editor([
    'extensions' => [
        new StarterKit([
            'heading' => ['HTMLAttributes' => ['class' => 'title']],
            'codeBlock' => false,
        ]),
    ],
]);
```

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

### Handle Overlapping Marks

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Example input structure demonstrating how the serializer handles multiple overlapping marks on text content.

```php
// Input with overlapping marks
[
    'type' => 'paragraph',
    'content' => [
        [
            'type' => 'text',
            'text' => 'Bold and italic',
            'marks' => [
                ['type' => 'bold'],
                ['type' => 'italic']
            ]
        ]
    ]
]

// Output: <p><strong><em>Bold and italic</em></strong></p>
```

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

### Editor Initialization

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/00-index.md

Initializes the editor with a set of extensions.

```APIDOC
## Method: new Editor

### Description
Creates a new instance of the editor with specified extensions.

### Signature
`new Editor(['extensions' => [...]])`
```

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

### Configure Syntax Highlighting

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/09-patterns-examples.md

Enables syntax highlighting for code blocks using either highlight.php or Shiki.

```php
$editor = new Editor([
    'extensions' => [
        new StarterKit(['codeBlock' => false]),
        new CodeBlockHighlight(),
    ],
]);
```

```php
$editor = new Editor([
    'extensions' => [
        new StarterKit(['codeBlock' => false]),
        new CodeBlockShiki([
            'theme' => 'github-dark',
            'defaultLanguage' => 'php',
            'guessLanguage' => true,
        ]),
    ],
]);
```

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

### Initialize Minify Class

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/07-utilities.md

Basic namespace declaration for the Minify utility.

```php
namespace Tiptap\Utils;

class Minify
```

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

### Configure Global Attribute Extensions

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/05-extensions-specialized.md

Initialize the editor with global attribute extensions like Color, FontFamily, and TextAlign, typically paired with TextStyle.

```php
$editor = new Editor([
    'extensions' => [
        new StarterKit(),
        new Color(['types' => ['textStyle']]),
        new FontFamily(['types' => ['textStyle']]),
        new TextAlign(['types' => ['paragraph', 'heading']]),
    ],
]);
```

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

### Render Instruction Formats

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Supported formats for defining HTML rendering rules within nodes and marks.

```php
['tag', ['attr' => 'val'], 0]      // Tag, attributes, children placeholder
['tag', 0]                          // Tag without attributes
[['tag', 0], ['span', 0]]          // Nested tags
['content' => '<html>...']          // Direct HTML output
null                                // Omit from output
```

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

### DOMSerializer::__construct

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Initializes a new instance of the DOMSerializer with a specific schema configuration.

```APIDOC
## public function __construct(Schema $schema)

### Description
Creates a serializer instance configured for a specific Tiptap schema.

### Parameters
- **schema** (Schema) - Required - The Schema instance defining the nodes and marks.
```

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

### Configure CodeBlockHighlight

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Configuration options for the CodeBlockHighlight extension.

```php
new CodeBlockHighlight([
    'languageClassPrefix' => 'hljs ',
    'HTMLAttributes' => [],
])
```

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

### DOMParser::__construct

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/06-schema-serializers.md

Initializes a new instance of the DOMParser with a specific schema.

```APIDOC
## __construct(Schema $schema)

### Description
Creates a parser for a specific schema.

### Parameters
- **schema** (Schema) - Required - Schema instance defining valid nodes and marks
```

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

### Integration Testing Workflows

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/09-patterns-examples.md

Demonstrates testing a full document transformation workflow by manipulating nodes via the descendants method.

```php
public function testFullWorkflow(): void {
    $original = '<h1>Title</h1><p>Paragraph with <strong>bold</strong></p>';

    $editor = new Editor();
    $html = $editor
        ->setContent($original)
        ->descendants(function (&$node) {
            if ($node->type === 'heading') {
                $node->attrs->level = 2;
            }
        })
        ->getHTML();

    $this->assertStringContainsString('<h2>Title</h2>', $html);
    $this->assertStringContainsString('<strong>bold</strong>', $html);
}
```

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

### Disable or Configure Nodes in StarterKit

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Manage nodes within a StarterKit by setting them to false to disable or providing an array to configure.

```php
new StarterKit([
    'codeBlock' => false,      // Disable code blocks
    'heading' => false,         // Disable headings
    'bulletList' => [           // Configure bullet lists
        'HTMLAttributes' => ['class' => 'list'],
    ],
])
```

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

### General Node Configuration Pattern

Source: https://github.com/ueberdosis/tiptap-php/blob/main/_autodocs/03-nodes-reference.md

Standard pattern for configuring nodes, allowing for custom HTML attributes.

```php
new NodeClass([
    'HTMLAttributes' => [
        'class' => 'custom-class',
        'data-x' => 'value',
    ],
    // ... node-specific options
])
```
Tokens:
Raw