tiptap/docs/installation/php.md

84 lines
2.1 KiB
Markdown
Raw Normal View History

---
2022-01-28 06:04:05 +08:00
title: PHP WYSIWYG
tableOfContents: true
---
2022-01-28 06:04:05 +08:00
# PHP
2021-01-30 05:05:47 +08:00
## Introduction
2022-01-28 06:04:05 +08:00
You can use Tiptap with Laravel, Livewire, Inertia.js, [Alpine.js](/installation/alpine), [Tailwind CSS](/guide/styling#with-tailwind-css), and even - yes you read that right - inside PHP.
## Tiptap for PHP
2023-08-28 16:56:28 +08:00
We provide [an official PHP package to work with Tiptap content](/api/utilities/tiptap-php). You can transform Tiptap-compatible JSON to HTML, and the other way around, sanitize your content, or just modify it.
2021-01-30 05:05:47 +08:00
2022-01-28 06:04:05 +08:00
## Laravel Livewire
### my-livewire-component.blade.php
```html
<!--
In your livewire component you could add an
autosave method to handle saving the content
from the editor every 10 seconds if you wanted
-->
<x-editor
wire:model="foo"
wire:poll.10000ms="autosave"
></x-editor>
```
### editor.blade.php
```html
<div
x-data="setupEditor(
$wire.entangle('{{ $attributes->wire('model')->value() }}').defer
)"
x-init="() => init($refs.editor)"
wire:ignore
{{ $attributes->whereDoesntStartWith('wire:model') }}
>
<div x-ref="editor"></div>
</div>
```
2021-02-08 23:41:57 +08:00
2022-01-28 06:04:05 +08:00
### index.js
2021-02-08 23:41:57 +08:00
```js
2021-05-07 00:41:22 +08:00
import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
2021-02-08 23:41:57 +08:00
window.setupEditor = function (content) {
let editor
2021-02-08 23:41:57 +08:00
return {
content: content,
2021-02-08 23:41:57 +08:00
init(element) {
editor = new Editor({
element: element,
2021-05-07 00:41:22 +08:00
extensions: [
StarterKit,
],
2021-02-08 23:41:57 +08:00
content: this.content,
onUpdate: ({ editor }) => {
this.content = editor.getHTML()
2021-02-08 23:41:57 +08:00
}
})
this.$watch('content', (content) => {
// If the new content matches TipTap's then we just skip.
if (content === editor.getHTML()) return
2021-02-08 23:41:57 +08:00
/*
Otherwise, it means that a force external to TipTap
is modifying the data on this Alpine component,
which could be Livewire itself.
In this case, we just need to update TipTap's
content and we're good to do.
For more information on the `setContent()` method, see:
https://www.tiptap.dev/api/commands/set-content
*/
editor.commands.setContent(content, false)
2021-02-08 23:41:57 +08:00
})
}
}
}
```