Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ueberdosis/tiptap-php
A PHP package to work with Tiptap content
https://github.com/ueberdosis/tiptap-php
php prosemirror tiptap
Last synced: 3 days ago
JSON representation
A PHP package to work with Tiptap content
- Host: GitHub
- URL: https://github.com/ueberdosis/tiptap-php
- Owner: ueberdosis
- License: mit
- Created: 2021-05-15T10:19:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-05T20:59:11.000Z (9 months ago)
- Last Synced: 2024-04-14T02:53:34.009Z (8 months ago)
- Topics: php, prosemirror, tiptap
- Language: PHP
- Homepage: https://tiptap.dev
- Size: 294 KB
- Stars: 161
- Watchers: 5
- Forks: 24
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-tiptap - Tiptap for PHP
- awesome-tiptap - Tiptap for PHP
README
# Tiptap for PHP
[](https://packagist.org/packages/ueberdosis/tiptap-php)
[](https://github.com/ueberdosis/tiptap-php/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/ueberdosis/tiptap-php)
[](https://packagist.org/packages/ueberdosis/tiptap-php)
[](https://discord.gg/WtJ49jGshW)
[](https://github.com/sponsors/ueberdosis)
A PHP package to work with [Tiptap](https://tiptap.dev/) content. You can transform Tiptap-compatible JSON to HTML, and the other way around, sanitize your content, or just modify it.
## Installation
You can install the package via composer:
```bash
composer require ueberdosis/tiptap-php
```
## Usage
The PHP package mimics large parts of the JavaScript package. If you know your way around Tiptap, the PHP syntax will feel familiar to you.
### Convert Tiptap HTML to JSON
Let’s start by converting a HTML snippet to a PHP array with a Tiptap-compatible structure:
```php
(new \Tiptap\Editor)
->setContent('
Example Text
')
->getDocument();
// Returns:
// ['type' => 'doc', 'content' => …]
```
You can get a JSON string in PHP, too.
```php
(new \Tiptap\Editor)
->setContent('
Example Text
')
->getJSON();
// Returns:
// {"type": "doc", "content": …}
```
### Convert Tiptap JSON to HTML
The other way works aswell. Just pass a JSON string or an PHP array to generate the HTML.
```php
(new \Tiptap\Editor)
->setContent([
'type' => 'doc',
'content' => [
[
'type' => 'paragraph',
'content' => [
[
'type' => 'text',
'text' => 'Example Text',
],
]
]
],
])
->getHTML();
// Returns:
//
Example Text
```
This doesn’t fully adhere to the ProseMirror schema. Some things are supported too, for example aren’t marks allowed in a `CodeBlock`.
If you need better schema support, create an issue with the feature you’re missing.
### Syntax highlighting for code blocks with [highlight.php](https://github.com/scrivo/highlight.php)
The default `CodeBlock` extension doesn’t add syntax highlighting to your code blocks. However, if you want to add syntax highlighting to your code blocks, there’s a special `CodeBlockHighlight` extension.
Swapping our the default one works like that:
```php
(new \Tiptap\Editor([
'extensions' => [
new \Tiptap\Extensions\StarterKit([
'codeBlock' => false,
]),
new \Tiptap\Nodes\CodeBlockHighlight(),
],
]))
->setContent('
<?php phpinfo()
')
->getHTML();
// Returns:
//
<?php phpinfo()
```
This is still unstyled. You need to [load a CSS file](https://highlightjs.org/download/) to add colors to the output, for example like that:
```html
```
Boom, syntax highlighting! By the way, this is powered by the amazing [scrivo/highlight.php](https://github.com/scrivo/highlight.php).
### Syntax highlighting for code blocks with [Shiki](https://github.com/shikijs/shiki) (Requires Node.js)
There is an alternate syntax highlighter that utilizes [Shiki](https://github.com/shikijs/shiki). Shiki is a beautiful syntax highlighter powered by the same language engine that many code editors use. The major differences from the `CodeBlockHighlight` extensions are, 1) you must install the `shiki` npm package, 2) Shiki code highlighting works by injecting inline styles so pulling in a external css file is not required, 3) you can use most VS Code themes to highlight your code.
To use the Shiki extension, first install the npm package
```bash
npm install shiki
```
Then follow the example below:
```php
(new \Tiptap\Editor([
'extensions' => [
new \Tiptap\Extensions\StarterKit([
'codeBlock' => false,
]),
new \Tiptap\Nodes\CodeBlockShiki,
],
]))
->setContent('
<?php phpinfo()
')
->getHTML();
```
To configure the theme or default language for code blocks pass additonal configuration into the constructor as show below:
```php
(new \Tiptap\Editor([
'extensions' => [
new \Tiptap\Extensions\StarterKit([
'codeBlock' => false,
]),
new \Tiptap\Nodes\CodeBlockShiki([
'theme' => 'github-dark', // default: nord, see https://github.com/shikijs/shiki/blob/main/docs/themes.md
'defaultLanguage' => 'php' // default: html, see https://github.com/shikijs/shiki/blob/main/docs/languages.md
'guessLanguage' => true // default: true, if the language isn’t passed, it tries to guess the language with highlight.php
]),
],
]))
->setContent('
<?php phpinfo()
')
->getHTML();
```
Under the hood the Shiki extension utilizes [Shiki PHP by Spatie](https://github.com/spatie/shiki-php), so please see the documentation for additional details and considerations.
### Convert content to plain text
Content can also be transformed to plain text, for example to put it into a search index.
```php
(new \Tiptap\Editor)
->setContent('
Heading
Paragraph
')
->getText();
// Returns:
// "Heading
//
// Paragraph"
```
What’s coming between blocks can be configured, too.
```php
(new \Tiptap\Editor)
->setContent('
Heading
Paragraph
')
->getText([
'blockSeparator' => "\n",
]);
// Returns:
// "Heading
// Paragraph"
```
### Sanitize content
A great use case for the PHP package is to clean (or “sanitize”) the content. You can do that with the `sanitize()` method. Works with JSON strings, PHP arrays and HTML.
It’ll return the same format you’re using as the input format.
```php
(new \Tiptap\Editor)
->sanitize('
Example Textalert("HACKED!")
');
// Returns:
// '
Example Text
'
```
### Modifying the content
With the `descendants()` method you can loop through all nodes recursively as you are used to from the JavaScript package. But in PHP, you can even modify the node to update attributes and all that.
> Warning: You need to add `&` to the parameter. Thats keeping a reference to the original item and allows to modify the original one, instead of just a copy.
```php
$editor->descendants(function (&$node) {
if ($node->type !== 'heading') {
return;
}
$node->attrs->level = 1;
});
```
### Configuration
Pass the configuration to the constructor of the editor. There’s not much to configure, but at least you can pass the initial content and load specific extensions.
```php
new \Tiptap\Editor([
'content' => '
Example Text
',
'extensions' => [
new \Tiptap\Extensions\StarterKit,
],
])
```
The `StarterKit` is loaded by default. If you just want to use that, there’s no need to set it.
### Extensions
By default, the [`StarterKit`](https://tiptap.dev/api/extensions/starter-kit) is loaded, but you can pass a custom array of extensions aswell.
```php
new \Tiptap\Editor([
'extensions' => [
new \Tiptap\Extensions\StarterKit,
new \Tiptap\Marks\Link,
],
])
```
### Configure extensions
Some extensions can be configured. Just pass an array to the constructor, that’s it. We’re aiming to support the same configuration as the JavaScript package.
```php
new \Tiptap\Editor([
'extensions' => [
// …
new \Tiptap\Nodes\Heading([
'levels' => [1, 2, 3],
]),
],
])
```
You can pass custom HTML attributes through the configuration, too.
```php
new \Tiptap\Editor([
'extensions' => [
// …
new \Tiptap\Nodes\Heading([
'HTMLAttributes' => [
'class' => 'my-custom-class',
],
]),
],
])
```
For the `StarterKit`, it’s slightly different, but works as you are used to from the JavaScript package.
```php
new \Tiptap\Editor([
'extensions' => [
new Tiptap\Extensions\StarterKit([
'codeBlock' => false,
'heading' => [
'HTMLAttributes' => [
'class' => 'my-custom-class',
],
]
]),
],
])
```
### Extend existing extensions
If you need to change minor details of the supported extensions, you can just extend an extension.
```php
instead of
return ['b', 0]
}
}
new \Tiptap\Editor([
'extensions' => [
new Paragraph,
new Text,
new CustomBold,
],
])
```
#### Custom extensions
You can even build custom extensions. If you are used to the JavaScript API, you will be surprised how much of that works in PHP, too. 🤯 Find a simple example below.
Make sure to dig through the extensions in this repository to learn more about the PHP extension API.
```php
[],
];
}
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]
}
}
```
#### Extension priority
Extensions are evaluated in the order of descending priority. By default, all Nodes, Marks, and Extensions, have a priority value of `100`.
Priority should be defined when creating a Node extension to match markup that could be matched be other Nodes - an example of this is the [TaskItem Node](src/Nodes/TaskItem.php) which has evaluation priority over the [ListItem Node](src/Nodes/ListItem.php).
## Testing
```bash
composer test
```
You can install nodemon (`npm install -g nodemon`) to keep the test suite running and watch for file changes:
```bash
composer test-watch
```
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Hans Pagel](https://github.com/hanspagel)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.