| Closure */ protected array | Closure $linkProtocols = ['http', 'https', 'ftp', 'ftps', 'mailto', 'tel', 'callto', 'sms', 'cid', 'xmpp']; protected bool | Closure | null $isJson = null; /** * @var array */ protected array $plugins = []; /** * @var array | null */ protected ?array $cachedPlugins = null; /** * @var array */ protected array $tools = []; /** * @var array | null */ protected ?array $cachedTools = null; /** * @var array | Closure | null */ protected array | Closure | null $mergeTags = null; /** * @var array | Closure | null */ protected array | Closure | null $mentions = null; /** * @var array> | Closure | null */ protected array | Closure | null $customBlocks = null; protected string | Closure | null $noMergeTagSearchResultsMessage = null; protected ?Closure $getFileAttachmentUrlFromAnotherRecordUsing = null; protected ?Closure $saveFileAttachmentFromAnotherRecordUsing = null; protected bool | Closure $shouldPreventFileAttachmentPathTampering = false; protected ?Closure $allowFileAttachmentPathUsing = null; protected string | Closure | null $activePanel = null; /** * @var array> */ protected array $cachedCustomBlocks; /** * @var array> | Closure | null */ protected array | Closure | null $floatingToolbars = null; /** * @var array | Closure | null */ protected array | Closure | null $textColors = null; protected bool | Closure | null $hasCustomTextColors = null; protected bool | Closure | null $hasResizableImages = null; protected function setUp(): void { parent::setUp(); $this->tools([ RichEditorTool::make('bold') ->label(__('filament-forms::components.rich_editor.tools.bold')) ->jsHandler('$getEditor()?.chain().focus().toggleBold().run()') ->toggle() ->icon(Heroicon::Bold) ->iconAlias('forms:components.rich-editor.toolbar.bold'), RichEditorTool::make('italic') ->label(__('filament-forms::components.rich_editor.tools.italic')) ->jsHandler('$getEditor()?.chain().focus().toggleItalic().run()') ->toggle() ->icon(Heroicon::Italic) ->iconAlias('forms:components.rich-editor.toolbar.italic'), RichEditorTool::make('underline') ->label(__('filament-forms::components.rich_editor.tools.underline')) ->jsHandler('$getEditor()?.chain().focus().toggleUnderline().run()') ->toggle() ->icon(Heroicon::Underline) ->iconAlias('forms:components.rich-editor.toolbar.underline'), RichEditorTool::make('strike') ->label(__('filament-forms::components.rich_editor.tools.strike')) ->jsHandler('$getEditor()?.chain().focus().toggleStrike().run()') ->toggle() ->icon(Heroicon::Strikethrough) ->iconAlias('forms:components.rich-editor.toolbar.strike'), RichEditorTool::make('subscript') ->label(__('filament-forms::components.rich_editor.tools.subscript')) ->jsHandler('$getEditor()?.chain().focus().toggleSubscript().run()') ->toggle() ->icon('fi-o-subscript') ->iconAlias('forms:components.rich-editor.toolbar.subscript'), RichEditorTool::make('superscript') ->label(__('filament-forms::components.rich_editor.tools.superscript')) ->jsHandler('$getEditor()?.chain().focus().toggleSuperscript().run()') ->toggle() ->icon('fi-o-superscript') ->iconAlias('forms:components.rich-editor.toolbar.superscript'), RichEditorTool::make('link') ->label(__('filament-forms::components.rich_editor.tools.link')) ->action(arguments: '{ url: $getEditor().getAttributes(\'link\')?.href, shouldOpenInNewTab: $getEditor().getAttributes(\'link\')?.target === \'_blank\' }') ->toggle() ->icon(Heroicon::Link) ->iconAlias('forms:components.rich-editor.toolbar.link'), RichEditorTool::make('textColor') ->label(__('filament-forms::components.rich_editor.tools.text_color')) ->action(arguments: '{ color: $getEditor().getAttributes(\'textColor\')[\'data-color\'] ?? null }') ->toggle() ->icon(Heroicon::Swatch) ->iconAlias('forms:components.rich-editor.toolbar.text-color'), RichEditorTool::make('h1') ->label(__('filament-forms::components.rich_editor.tools.h1')) ->jsHandler('$getEditor()?.chain().focus().toggleHeading({ level: 1 }).run()') ->toggle() ->activeKey('heading') ->activeOptions(['level' => 1]) ->icon('fi-o-h1') ->iconAlias('forms:components.rich-editor.toolbar.h1'), RichEditorTool::make('h2') ->label(__('filament-forms::components.rich_editor.tools.h2')) ->jsHandler('$getEditor()?.chain().focus().toggleHeading({ level: 2 }).run()') ->toggle() ->activeKey('heading') ->activeOptions(['level' => 2]) ->icon('fi-o-h2') ->iconAlias('forms:components.rich-editor.toolbar.h2'), RichEditorTool::make('h3') ->label(__('filament-forms::components.rich_editor.tools.h3')) ->jsHandler('$getEditor()?.chain().focus().toggleHeading({ level: 3 }).run()') ->toggle() ->activeKey('heading') ->activeOptions(['level' => 3]) ->icon('fi-o-h3') ->iconAlias('forms:components.rich-editor.toolbar.h3'), RichEditorTool::make('paragraph') ->label(__('filament-forms::components.rich_editor.tools.paragraph')) ->jsHandler('$getEditor()?.chain().focus().setParagraph().run()') ->toggle() ->icon('fi-o-paragraph') ->iconAlias('forms:components.rich-editor.toolbar.paragraph'), RichEditorTool::make('h4') ->label(__('filament-forms::components.rich_editor.tools.h4')) ->jsHandler('$getEditor()?.chain().focus().toggleHeading({ level: 4 }).run()') ->toggle() ->activeKey('heading') ->activeOptions(['level' => 4]) ->icon('fi-o-h4') ->iconAlias('forms:components.rich-editor.toolbar.h4'), RichEditorTool::make('h5') ->label(__('filament-forms::components.rich_editor.tools.h5')) ->jsHandler('$getEditor()?.chain().focus().toggleHeading({ level: 5 }).run()') ->toggle() ->activeKey('heading') ->activeOptions(['level' => 5]) ->icon('fi-o-h5') ->iconAlias('forms:components.rich-editor.toolbar.h5'), RichEditorTool::make('h6') ->label(__('filament-forms::components.rich_editor.tools.h6')) ->jsHandler('$getEditor()?.chain().focus().toggleHeading({ level: 6 }).run()') ->toggle() ->activeKey('heading') ->activeOptions(['level' => 6]) ->icon('fi-o-h6') ->iconAlias('forms:components.rich-editor.toolbar.h6'), RichEditorTool::make('blockquote') ->label(__('filament-forms::components.rich_editor.tools.blockquote')) ->jsHandler('$getEditor()?.chain().focus().toggleBlockquote().run()') ->toggle() ->icon(Heroicon::ChatBubbleBottomCenterText) ->iconAlias('forms:components.rich-editor.toolbar.blockquote'), RichEditorTool::make('code') ->label(__('filament-forms::components.rich_editor.tools.code')) ->jsHandler('$getEditor()?.chain().focus().toggleCode().run()') ->toggle() ->icon('fi-o-code') ->iconAlias('forms:components.rich-editor.toolbar.code'), RichEditorTool::make('codeBlock') ->label(__('filament-forms::components.rich_editor.tools.code_block')) ->jsHandler('$getEditor()?.chain().focus().toggleCodeBlock().run()') ->toggle() ->icon('fi-o-code-block') ->iconAlias('forms:components.rich-editor.toolbar.code-block'), RichEditorTool::make('bulletList') ->label(__('filament-forms::components.rich_editor.tools.bullet_list')) ->jsHandler('$getEditor()?.chain().focus().toggleBulletList().run()') ->toggle() ->icon(Heroicon::ListBullet) ->iconAlias('forms:components.rich-editor.toolbar.bullet-list'), RichEditorTool::make('orderedList') ->label(__('filament-forms::components.rich_editor.tools.ordered_list')) ->jsHandler('$getEditor()?.chain().focus().toggleOrderedList().run()') ->toggle() ->icon(Heroicon::NumberedList) ->iconAlias('forms:components.rich-editor.toolbar.ordered-list'), RichEditorTool::make('table') ->label(__('filament-forms::components.rich_editor.tools.table')) ->jsHandler('$getEditor()?.commands.insertTable({ rows: 2, cols: 3, withHeaderRow: true })') ->icon('fi-o-table') ->iconAlias('forms:components.rich-editor.toolbar.table'), RichEditorTool::make('tableAddColumnBefore') ->label(__('filament-forms::components.rich_editor.tools.table_add_column_before')) ->jsHandler('$getEditor()?.chain().focus().addColumnBefore().run()') ->icon('fi-o-table-add-column-before') ->iconAlias('forms:components.rich-editor.toolbar.table_add_column_before'), RichEditorTool::make('tableAddColumnAfter') ->label(__('filament-forms::components.rich_editor.tools.table_add_column_after')) ->jsHandler('$getEditor()?.chain().focus().addColumnAfter().run()') ->icon('fi-o-table-add-column-after') ->iconAlias('forms:components.rich-editor.toolbar.table_add_column_after'), RichEditorTool::make('tableDeleteColumn') ->label(__('filament-forms::components.rich_editor.tools.table_delete_column')) ->jsHandler('$getEditor()?.chain().focus().deleteColumn().run()') ->icon('fi-o-table-delete-column') ->iconAlias('forms:components.rich-editor.toolbar.table_delete_column'), RichEditorTool::make('tableAddRowBefore') ->label(__('filament-forms::components.rich_editor.tools.table_add_row_before')) ->jsHandler('$getEditor()?.chain().focus().addRowBefore().run()') ->icon('fi-o-table-add-row-before') ->iconAlias('forms:components.rich-editor.toolbar.table_add_row_before'), RichEditorTool::make('tableAddRowAfter') ->label(__('filament-forms::components.rich_editor.tools.table_add_row_after')) ->jsHandler('$getEditor()?.chain().focus().addRowAfter().run()') ->icon('fi-o-table-add-row-after') ->iconAlias('forms:components.rich-editor.toolbar.table_add_row_after'), RichEditorTool::make('tableDeleteRow') ->label(__('filament-forms::components.rich_editor.tools.table_delete_row')) ->jsHandler('$getEditor()?.chain().focus().deleteRow().run()') ->icon('fi-o-table-delete-row') ->iconAlias('forms:components.rich-editor.toolbar.table_delete_row'), RichEditorTool::make('tableMergeCells') ->label(__('filament-forms::components.rich_editor.tools.table_merge_cells')) ->jsHandler('$getEditor()?.chain().focus().mergeCells().run()') ->icon('fi-o-table-merge-cells') ->iconAlias('forms:components.rich-editor.toolbar.table_merge_cells'), RichEditorTool::make('tableSplitCell') ->label(__('filament-forms::components.rich_editor.tools.table_split_cell')) ->jsHandler('$getEditor()?.chain().focus().splitCell().run()') ->icon('fi-o-table-split-cell') ->iconAlias('forms:components.rich-editor.toolbar.table_split_cell'), RichEditorTool::make('tableToggleHeaderRow') ->label(__('filament-forms::components.rich_editor.tools.table_toggle_header_row')) ->jsHandler('$getEditor()?.chain().focus().toggleHeaderRow().run()') ->icon('fi-o-table-toggle-header-row') ->iconAlias('forms:components.rich-editor.toolbar.table_toggle_header_row'), RichEditorTool::make('tableToggleHeaderCell') ->label(__('filament-forms::components.rich_editor.tools.table_toggle_header_cell')) ->jsHandler('$getEditor()?.chain().focus().toggleHeaderCell().run()') ->icon('fi-o-table-toggle-header-cell') ->iconAlias('forms:components.rich-editor.toolbar.table_toggle_header_cell'), RichEditorTool::make('tableDelete') ->label(__('filament-forms::components.rich_editor.tools.table_delete')) ->jsHandler('$getEditor()?.chain().focus().deleteTable().run()') ->icon('fi-o-table-delete') ->iconAlias('forms:components.rich-editor.toolbar.table_delete'), RichEditorTool::make('attachFiles') ->label(__('filament-forms::components.rich_editor.tools.attach_files')) ->action(arguments: '{ alt: $getEditor().getAttributes(\'image\')?.alt, id: $getEditor().getAttributes(\'image\')?.id, src: $getEditor().getAttributes(\'image\')?.src }') ->activeKey('image') ->icon(Heroicon::PaperClip) ->iconAlias('forms:components.rich-editor.toolbar.attach-files'), RichEditorTool::make('customBlocks') ->label(__('filament-forms::components.rich_editor.tools.custom_blocks')) ->jsHandler('togglePanel(\'customBlocks\')') ->activeJsExpression('isPanelActive(\'customBlocks\')') ->icon(Heroicon::SquaresPlus) ->iconAlias('forms:components.rich-editor.toolbar.custom-blocks'), RichEditorTool::make('mergeTags') ->label(__('filament-forms::components.rich_editor.tools.merge_tags')) ->jsHandler('togglePanel(\'mergeTags\')') ->activeJsExpression('isPanelActive(\'mergeTags\')') ->icon('fi-o-merge-tag') ->iconAlias('forms:components.rich-editor.toolbar.merge-tags'), RichEditorTool::make('horizontalRule') ->label(__('filament-forms::components.rich_editor.tools.horizontal_rule')) ->jsHandler('$getEditor()?.chain().focus().setHorizontalRule().run()') ->icon(Heroicon::Minus) ->iconAlias('forms:components.rich-editor.toolbar.horizontal-rule'), RichEditorTool::make('highlight') ->label(__('filament-forms::components.rich_editor.tools.highlight')) ->jsHandler('$getEditor()?.chain().focus().toggleHighlight().run()') ->toggle() ->icon('fi-o-highlight') ->iconAlias('forms:components.rich-editor.toolbar.highlight'), RichEditorTool::make('small') ->label(__('filament-forms::components.rich_editor.tools.small')) ->jsHandler('$getEditor()?.chain().focus().toggleSmall().run()') ->toggle() ->icon('fi-o-small') ->iconAlias('forms:components.rich-editor.toolbar.small'), RichEditorTool::make('lead') ->label(__('filament-forms::components.rich_editor.tools.lead')) ->jsHandler('$getEditor()?.chain().focus().toggleLead().run()') ->toggle() ->icon('fi-o-lead') ->iconAlias('forms:components.rich-editor.toolbar.lead'), RichEditorTool::make('undo') ->label(__('filament-forms::components.rich_editor.tools.undo')) ->jsHandler('$getEditor()?.chain().focus().undo().run()') ->icon(Heroicon::ArrowUturnLeft) ->iconAlias('forms:components.rich-editor.toolbar.undo'), RichEditorTool::make('redo') ->label(__('filament-forms::components.rich_editor.tools.redo')) ->jsHandler('$getEditor()?.chain().focus().redo().run()') ->icon(Heroicon::ArrowUturnRight) ->iconAlias('forms:components.rich-editor.toolbar.redo'), RichEditorTool::make('alignStart') ->label(__('filament-forms::components.rich_editor.tools.align_start')) ->jsHandler('$getEditor()?.chain().focus().setTextAlign(\'start\').run()') ->activeJsExpression('$getEditor()?.isActive({ textAlign: \'start\' })') ->toggle() ->icon('fi-o-align-start') ->iconAlias('forms:components.rich-editor.toolbar.align-start'), RichEditorTool::make('alignCenter') ->label(__('filament-forms::components.rich_editor.tools.align_center')) ->jsHandler('$getEditor()?.chain().focus().setTextAlign(\'center\').run()') ->activeJsExpression('$getEditor()?.isActive({ textAlign: \'center\' })') ->toggle() ->icon('fi-o-align-center') ->iconAlias('forms:components.rich-editor.toolbar.align-center'), RichEditorTool::make('alignEnd') ->label(__('filament-forms::components.rich_editor.tools.align_end')) ->jsHandler('$getEditor()?.chain().focus().setTextAlign(\'end\').run()') ->activeJsExpression('$getEditor()?.isActive({ textAlign: \'end\' })') ->toggle() ->icon('fi-o-align-end') ->iconAlias('forms:components.rich-editor.toolbar.align-end'), RichEditorTool::make('alignJustify') ->label(__('filament-forms::components.rich_editor.tools.align_justify')) ->jsHandler('$getEditor()?.chain().focus().setTextAlign(\'justify\').run()') ->activeJsExpression('$getEditor()?.isActive({ textAlign: \'justify\' })') ->toggle() ->icon('fi-o-align-justify') ->iconAlias('forms:components.rich-editor.toolbar.align-justify'), RichEditorTool::make('grid') ->label(__('filament-forms::components.rich_editor.tools.grid')) ->action() ->activeJsExpression('false') ->icon('fi-o-columns') ->iconAlias('forms:components.rich-editor.toolbar.grid'), RichEditorTool::make('gridDelete') ->label(__('filament-forms::components.rich_editor.tools.grid_delete')) ->jsHandler('$getEditor()?.chain().focus().deleteNode(\'grid\').run()') ->activeKey('grid') ->activeStyling(false) ->disabledWhenNotActive() ->icon('fi-o-columns-delete') ->iconAlias('forms:components.rich-editor.toolbar.grid_delete'), RichEditorTool::make('details') ->label(__('filament-forms::components.rich_editor.tools.details')) ->jsHandler('$getEditor()?.chain().focus().setDetails().run()') ->icon('fi-o-details') ->iconAlias('forms:components.rich-editor.toolbar.details'), RichEditorTool::make('clearFormatting') ->label(__('filament-forms::components.rich_editor.tools.clear_formatting')) ->jsHandler('$getEditor()?.chain().focus().clearNodes().unsetAllMarks().run()') ->icon('fi-o-clear-formatting') ->iconAlias('forms:components.rich-editor.toolbar.clear_formatting'), ]); $this->beforeStateDehydrated(static function (RichEditor $component): void { $component->saveFileAttachments(); }, shouldUpdateValidatedStateAfter: true); $this->saveRelationshipsUsing(static function (RichEditor $component): void { $component->saveFileAttachmentsToRecord(); }); $this->rule(static function (RichEditor $component): Closure { return static function (string $attribute, mixed $value, Closure $fail) use ($component): void { if (blank($value)) { return; } $originalPaths = $component->getOriginalFileAttachmentPaths(); $attachmentIds = []; $component->getTipTapEditor() ->setContent($value) ->descendants(function (object $node) use (&$attachmentIds): void { if ($node->type !== 'image') { return; } $id = $node->attrs->id ?? null; if (blank($id)) { return; } $attachmentIds[] = $id; }); foreach ($attachmentIds as $id) { if ($component->getUploadedFileAttachment($id) !== null) { continue; } if ($component->isFileAttachmentPathAuthorized($id, $originalPaths)) { continue; } $fail(__($component->getValidationMessages()['tampered'] ?? 'filament-forms::validation.tampered_file_path', ['attribute' => $component->getValidationAttribute()])); return; } }; }, static fn (RichEditor $component): bool => $component->shouldPreventFileAttachmentPathTampering()); } /** * @return array */ public function resolveFileAttachmentIds(): array { $fileAttachmentIds = []; $this->rawState( $this->getTipTapEditor() ->setContent($this->getRawState() ?? [ 'type' => 'doc', 'content' => [], ]) ->descendants(function (object &$node) use (&$fileAttachmentIds): void { if ($node->type !== 'image') { return; } if (blank($node->attrs->id ?? null)) { return; } $attachment = $this->getUploadedFileAttachment($node->attrs->id); if ($attachment) { $node->attrs->id = $this->saveUploadedFileAttachment($attachment); $node->attrs->src = $this->getFileAttachmentUrl($node->attrs->id); $fileAttachmentIds[] = $node->attrs->id; return; } if (filled($this->getFileAttachmentUrl($node->attrs->id))) { $fileAttachmentIds[] = $node->attrs->id; return; } $fileAttachmentIdFromAnotherRecord = $this->saveFileAttachmentFromAnotherRecord($node->attrs->id); if (blank($fileAttachmentIdFromAnotherRecord)) { $fileAttachmentIds[] = $node->attrs->id; return; } $node->attrs->id = $fileAttachmentIdFromAnotherRecord; $node->attrs->src = $this->getFileAttachmentUrl($fileAttachmentIdFromAnotherRecord) ?? $node->attrs->src ?? null; }) ->getDocument(), ); return $fileAttachmentIds; } public function preventFileAttachmentPathTampering(bool | Closure $condition = true, ?Closure $allowFilePathUsing = null): static { $this->shouldPreventFileAttachmentPathTampering = $condition; $this->allowFileAttachmentPathUsing = $allowFilePathUsing; return $this; } public function shouldPreventFileAttachmentPathTampering(): bool { return (bool) $this->evaluate($this->shouldPreventFileAttachmentPathTampering); } /** * @param array | null $originalPaths */ public function isFileAttachmentPathAuthorized(string $file, ?array $originalPaths = null): bool { if (in_array($file, $originalPaths ?? $this->getOriginalFileAttachmentPaths(), strict: true)) { return true; } if ($this->allowFileAttachmentPathUsing) { return (bool) $this->evaluate($this->allowFileAttachmentPathUsing, [ 'file' => $file, ]); } return false; } /** * @return array */ public function getOriginalFileAttachmentPaths(): array { $record = $this->getRecord(); if (! $record instanceof Model) { return []; } $attribute = $this->getName(); $originalContent = $record->getOriginal($attribute, $record->getAttribute($attribute)); if (blank($originalContent)) { return []; } $ids = []; $this->getTipTapEditor() ->setContent($originalContent) ->descendants(function (object $node) use (&$ids): void { if ($node->type !== 'image') { return; } if (blank($node->attrs->id ?? null)) { return; } $ids[] = $node->attrs->id; }); return $ids; } public function saveFileAttachments(): void { $fileAttachmentProvider = $this->getFileAttachmentProvider(); if ($fileAttachmentProvider?->isExistingRecordRequiredToSaveNewFileAttachments() && (! $this->getRecord())) { return; } $fileAttachmentIds = $this->resolveFileAttachmentIds(); $fileAttachmentProvider?->cleanUpFileAttachments(exceptIds: $fileAttachmentIds); } public function saveFileAttachmentsToRecord(): void { $fileAttachmentProvider = $this->getFileAttachmentProvider(); if (! $fileAttachmentProvider) { return; } if (! $fileAttachmentProvider->isExistingRecordRequiredToSaveNewFileAttachments()) { return; } $record = $this->getRecord(); if (! $record->wasRecentlyCreated) { return; } $fileAttachmentIds = $this->resolveFileAttachmentIds(); $record->setAttribute($this->getContentAttribute()->getName(), $this->getState()); $record->save(); $fileAttachmentProvider->cleanUpFileAttachments(exceptIds: $fileAttachmentIds); } public function isDehydrated(): bool { if ($this->getFileAttachmentProvider()?->isExistingRecordRequiredToSaveNewFileAttachments() && (! $this->getRecord())) { return false; } return parent::isDehydrated(); } /** * @param array | Closure $extensions */ public function plugins(array | Closure $extensions): static { $this->plugins = [ ...$this->plugins, ...is_array($extensions) ? $extensions : [$extensions], ]; $this->cachedPlugins = null; $this->cachedTools = null; return $this; } /** * @param array | Closure $tools */ public function tools(array | Closure $tools): static { $this->tools = [ ...$this->tools, ...is_array($tools) ? $tools : [$tools], ]; $this->cachedTools = null; return $this; } /** * @return array */ public function getDefaultStateCasts(): array { return [ ...parent::getDefaultStateCasts(), app(RichEditorStateCast::class, ['richEditor' => $this]), ]; } /** * @param array $commands * @param ?array $editorSelection */ public function runCommands(array $commands, ?array $editorSelection = null): void { $key = $this->getKey(); $livewire = $this->getLivewire(); $livewire->dispatch( 'run-rich-editor-commands', awaitSchemaComponent: $key, livewireId: $livewire->getId(), key: $key, editorSelection: $editorSelection, commands: array_map(fn (EditorCommand $command): array => $command->toArray(), $commands), ); } public function uploadingFileMessage(string | Closure | null $message): static { $this->uploadingFileMessage = $message; return $this; } public function getUploadingFileMessage(): string { return $this->evaluate($this->uploadingFileMessage) ?? __('filament-forms::components.rich_editor.uploading_file_message'); } public function json(bool | Closure | null $condition = true): static { $this->isJson = $condition; return $this; } public function isJson(): bool { return $this->evaluate($this->isJson) ?? $this->getContentAttribute()?->isJson() ?? false; } public function getTipTapEditor(): Editor { return RichContentRenderer::make() ->plugins($this->getPlugins()) ->linkProtocols($this->getLinkProtocols()) ->getEditor(); } /** * @param array | Closure $protocols */ public function linkProtocols(array | Closure $protocols): static { $this->linkProtocols = $protocols; return $this; } /** * @return array */ public function getLinkProtocols(): array { return $this->evaluate($this->linkProtocols); } /** * @return array */ public function getPlugins(): array { return $this->cachedPlugins ??= [ ...$this->getContentAttribute()?->getPlugins() ?? [], ...array_reduce( $this->plugins, function (array $carry, RichContentPlugin | Closure $plugin): array { if ($plugin instanceof Closure) { $plugin = $this->evaluate($plugin); } return [ ...$carry, ...Arr::wrap($plugin), ]; }, initial: [], ), ]; } /** * @return array */ public function getTipTapJsExtensions(): array { return array_reduce( $this->getPlugins(), fn (array $carry, RichContentPlugin $plugin): array => [ ...$carry, ...$plugin->getTipTapJsExtensions(), ], initial: [], ); } /** * @return array */ public function getTools(): array { return $this->cachedTools ??= array_reduce( [ ...array_reduce( $this->tools, function (array $carry, RichEditorTool | Closure $tool): array { if ($tool instanceof Closure) { $tool = $this->evaluate($tool); } return [ ...$carry, ...Arr::wrap($tool), ]; }, initial: [], ), ...array_reduce( $this->getPlugins(), fn (array $carry, RichContentPlugin $plugin): array => [ ...$carry, ...$plugin->getEditorTools(), ], initial: [], ), ], fn (array $carry, RichEditorTool $tool): array => [ ...$carry, $tool->getName() => $tool->editor($this), ], initial: [], ); } /** * @return array> */ public function getToolbarButtons(): array { $groups = $this->getBaseToolbarButtons(); $tools = $this->getTools(); return array_map( fn (array $group): array => array_map( fn (string | ToolbarButtonGroup $item): string | ToolbarButtonGroup => $item instanceof ToolbarButtonGroup ? $item->resolve($tools) : $item, $group, ), $groups, ); } public function getContentAttribute(): ?RichContentAttribute { // Do not read content attributes from the model when the // rich editor is nested inside a custom block action // modal — the content attribute should only be used // to configure the parent rich editor. if ($this->getRootContainer()->getOperation() === CustomBlockAction::NAME) { return null; } $model = $this->getModelInstance(); if (! ($model instanceof HasRichContent)) { return null; } return $model->getRichContentAttribute($this->getName()); } public function getDefaultFileAttachmentsDiskName(): ?string { return $this->getContentAttribute()?->getFileAttachmentsDiskName(); } public function getDefaultFileAttachmentsVisibility(): ?string { return $this->getContentAttribute()?->getFileAttachmentsVisibility(); } public function getFileAttachmentProvider(): ?FileAttachmentProvider { return $this->getContentAttribute()?->getFileAttachmentProvider(); } public function getDefaultFileAttachmentUrl(mixed $file): ?string { return $this->getFileAttachmentProvider()?->getFileAttachmentUrl($file); } public function defaultSaveUploadedFileAttachment(TemporaryUploadedFile $file): mixed { return $this->getFileAttachmentProvider()?->saveUploadedFileAttachment($file); } /** * @return array> */ public function getDefaultFloatingToolbars(): array { return [ 'table' => [ 'tableAddColumnBefore', 'tableAddColumnAfter', 'tableDeleteColumn', 'tableAddRowBefore', 'tableAddRowAfter', 'tableDeleteRow', 'tableMergeCells', 'tableSplitCell', 'tableToggleHeaderRow', 'tableToggleHeaderCell', 'tableDelete', ], ]; } /** * @return array>>}> */ protected function getExtraToolbarButtonsModifications(): array { $modifications = []; foreach ($this->getPlugins() as $plugin) { if (! ($plugin instanceof HasToolbarButtons)) { continue; } $enabledButtons = $plugin->getEnabledToolbarButtons(); if (filled($enabledButtons)) { $modifications[] = [ 'type' => 'enable', 'buttons' => $enabledButtons, ]; } $disabledButtons = $plugin->getDisabledToolbarButtons(); if (filled($disabledButtons)) { $modifications[] = [ 'type' => 'disable', 'buttons' => $disabledButtons, ]; } } return $modifications; } protected function hasToolbarButtonInItem(object $item, string $button): bool { if ($item instanceof ToolbarButtonGroup) { return in_array($button, $item->getButtons()); } return false; } /** * @param array $buttonsToDisable */ protected function filterDisabledToolbarButtonsFromItem(object $item, array $buttonsToDisable): ?object { if (! ($item instanceof ToolbarButtonGroup)) { return $item; } $buttons = array_values(array_filter( $item->getButtons(), static fn (string $button): bool => ! in_array($button, $buttonsToDisable), )); if (blank($buttons)) { return null; } $item = clone $item; $item->buttons($buttons); return $item; } /** * @return array> */ public function getDefaultToolbarButtons(): array { return [ ['bold', 'italic', 'underline', 'strike', 'subscript', 'superscript', 'link'], ['h2', 'h3'], ['alignStart', 'alignCenter', 'alignEnd'], ['blockquote', 'codeBlock', 'bulletList', 'orderedList'], [ 'table', ...($this->hasFileAttachments(default: true) ? ['attachFiles'] : []), ...(filled($this->getCustomBlocks()) ? ['customBlocks'] : []), ...(filled($this->getMergeTags()) ? ['mergeTags'] : []), ], ['undo', 'redo'], ]; } public function getFileAttachmentUrlFromAnotherRecordUsing(?Closure $callback): static { $this->getFileAttachmentUrlFromAnotherRecordUsing = $callback; return $this; } public function saveFileAttachmentFromAnotherRecordUsing(?Closure $callback): static { $this->saveFileAttachmentFromAnotherRecordUsing = $callback; return $this; } public function getFileAttachmentUrlFromAnotherRecord(mixed $file): ?string { return $this->evaluate($this->getFileAttachmentUrlFromAnotherRecordUsing, [ 'file' => $file, ]); } public function saveFileAttachmentFromAnotherRecord(mixed $file): mixed { return $this->evaluate($this->saveFileAttachmentFromAnotherRecordUsing, [ 'file' => $file, ]); } /** * @return array */ public function getDefaultActions(): array { return [ AttachFilesAction::make(), CustomBlockAction::make(), GridAction::make(), LinkAction::make(), TextColorAction::make(), ...array_reduce( $this->getPlugins(), fn (array $carry, RichContentPlugin $plugin): array => [ ...$carry, ...$plugin->getEditorActions(), ], initial: [], ), ]; } /** * @param array | Closure | null $tags */ public function mergeTags(array | Closure | null $tags): static { $this->mergeTags = $tags; return $this; } /** * @return array */ public function getMergeTags(): array { $mergeTags = $this->evaluate($this->mergeTags) ?? $this->getContentAttribute()?->getMergeTags() ?? []; return Arr::mapWithKeys( $mergeTags, fn (string $label, int | string $id): array => [(is_string($id) ? $id : $label) => $label], ); } /** * @param array | Closure $providers */ public function mentions(array | Closure $providers): static { $this->mentions = $providers; return $this; } /** * @return array */ public function getMentionProviders(): array { return [ ...($this->getContentAttribute()?->getMentionProviders() ?? []), ...($this->evaluate($this->mentions) ?? []), ]; } /** * @return array, isSearchable: bool, items: array, noOptionsMessage: string, noSearchResultsMessage: string, searchPrompt: string, searchingMessage: string}> */ public function getMentionsForJs(): array { return array_map( function (MentionProvider $provider): array { return [ 'char' => $provider->getChar(), 'extraAttributes' => $provider->getExtraAttributes(), 'isSearchable' => $provider->hasSearchResultsUsing(), 'items' => $provider->getItems(), 'noOptionsMessage' => $provider->getNoItemsMessage(), 'noSearchResultsMessage' => $provider->getNoSearchResultsMessage(), 'searchPrompt' => $provider->getSearchPrompt(), 'searchingMessage' => $provider->getSearchingMessage(), ]; }, $this->getMentionProviders(), ); } /** * @return array */ #[ExposedLivewireMethod] #[Renderless] public function getMentionSearchResultsForJs(?string $search = null, ?string $char = '@'): array { $char = $char ?? '@'; $providers = $this->getMentionProviders(); $provider = collect($providers)->first(function (MentionProvider $mentionProvider) use ($char): bool { return $mentionProvider->getChar() === $char; }) ?? ($providers[0] ?? null); if (! $provider) { return []; } return $provider->getSearchResults($search ?? ''); } /** * @param array $mentions * @return array */ #[ExposedLivewireMethod] #[Renderless] public function getMentionLabelsForJs(array $mentions = []): array { $providers = $this->getMentionProviders(); $labels = []; $mentionsByChar = collect($mentions)->groupBy('char'); foreach ($mentionsByChar as $char => $charMentions) { $provider = collect($providers)->first(function (MentionProvider $mentionProvider) use ($char): bool { return $mentionProvider->getChar() === $char; }) ?? ($providers[0] ?? null); if (! $provider) { continue; } $ids = $charMentions->pluck('id')->all(); $charLabels = $provider->getLabels($ids); foreach ($charLabels as $id => $label) { $labels[$id] = $label; } } return $labels; } public function hasMentions(): bool { return isset($this->mentions); } public function noMergeTagSearchResultsMessage(string | Closure | null $message): static { $this->noMergeTagSearchResultsMessage = $message; return $this; } public function getNoMergeTagSearchResultsMessage(): string | Htmlable { return $this->evaluate($this->noMergeTagSearchResultsMessage) ?? __('filament-forms::components.rich_editor.no_merge_tag_search_results_message'); } public function activePanel(string | Closure | null $panel): static { $this->activePanel = $panel; return $this; } public function getActivePanel(): ?string { return $this->evaluate($this->activePanel); } /** * @param array | array>> | Closure | null $blocks */ public function customBlocks(array | Closure | null $blocks): static { $this->customBlocks = $blocks; return $this; } /** * @return array | array>> */ protected function resolveCustomBlocks(): array { return $this->evaluate($this->customBlocks) ?? $this->getContentAttribute()?->getCustomBlocksConfig() ?? []; } /** * @return array> */ public function getCustomBlocks(): array { $blocks = $this->resolveCustomBlocks(); $result = []; foreach ($blocks as $value) { if (is_array($value)) { foreach ($value as $innerKey => $innerValue) { $result[] = is_string($innerKey) ? $innerKey : $innerValue; } } else { $result[] = $value; } } return $result; } /** * @return array> */ public function getCachedCustomBlocks(): array { if (isset($this->cachedCustomBlocks)) { return $this->cachedCustomBlocks; } $this->cachedCustomBlocks = []; foreach ($this->getCustomBlocks() as $block) { $this->cachedCustomBlocks[$block::getId()] = $block; } return $this->cachedCustomBlocks; } /** * @return ?class-string */ public function getCustomBlock(string $id): ?string { return $this->getCachedCustomBlocks()[$id] ?? null; } /** * @return Collection>> */ public function getGroupedCustomBlocks(): Collection { $blocks = $this->resolveCustomBlocks(); $ungrouped = []; $groups = collect(); foreach ($blocks as $key => $value) { if (is_string($key) && is_array($value)) { $groupBlocks = []; foreach ($value as $innerKey => $innerValue) { $groupBlocks[] = is_string($innerKey) ? $innerKey : $innerValue; } $groups->put($key, collect($groupBlocks)); } elseif (is_array($value)) { foreach ($value as $innerKey => $innerValue) { $ungrouped[] = is_string($innerKey) ? $innerKey : $innerValue; } } else { $ungrouped[] = $value; } } $result = collect(); if (! empty($ungrouped)) { $result->put('', collect($ungrouped)); } return $result->merge($groups); } /** * @param array> | Closure | null $toolbars */ public function floatingToolbars(array | Closure | null $toolbars): static { $this->floatingToolbars = $toolbars; return $this; } /** * @return array> */ public function getFloatingToolbars(): array { $toolbars = $this->evaluate($this->floatingToolbars) ?? $this->getDefaultFloatingToolbars(); $tools = $this->getTools(); return array_map( fn (array $buttons): array => array_map( fn (string | ToolbarButtonGroup $item): string | ToolbarButtonGroup => $item instanceof ToolbarButtonGroup ? $item->resolve($tools) : $item, $buttons, ), $toolbars, ); } public function getLengthValidationRules(): array { $rules = []; if (filled($maxLength = $this->getMaxLength())) { $rules[] = function (string $attribute, mixed $value, Closure $fail) use ($maxLength): void { if (blank($value)) { return; } $textLength = Str::length($this->getTipTapEditor() ->setContent($value) ->getText()); if ($textLength > $maxLength) { $fail('validation.max.string')->translate([ 'max' => $maxLength, ]); } }; } if (filled($minLength = $this->getMinLength())) { $rules[] = function (string $attribute, mixed $value, Closure $fail) use ($minLength): void { if (blank($value)) { return; } $textLength = Str::length($this->getTipTapEditor() ->setContent($value) ->getText()); if ($textLength < $minLength) { $fail('validation.min.string')->translate([ 'min' => $minLength, ]); } }; } if (filled($length = $this->getLength())) { $rules[] = function (string $attribute, mixed $value, Closure $fail) use ($length): void { if (blank($value)) { return; } $textLength = Str::length($this->getTipTapEditor() ->setContent($value) ->getText()); if ($textLength !== $length) { $fail('validation.size.string')->translate([ 'size' => $length, ]); } }; } return $rules; } public function getRequiredValidationRule(): string | Closure { if (! $this->isRequired()) { return 'nullable'; } return function (string $attribute, mixed $value, Closure $fail): void { if (blank($value)) { return; } $isEmpty = is_array($value) && (($value['type'] ?? null) === 'doc') && (count($value['content'] ?? []) === 1) && (($value['content'][0]['type'] ?? null) === 'paragraph') && blank($value['content'][0]['content'] ?? []); if ($isEmpty) { $fail('validation.required')->translate(); } }; } public function callAfterStateUpdated(bool $shouldBubbleToParents = true): static { $rawState = $this->getRawState(); // https://github.com/filamentphp/filament/issues/17472 if (! is_array($rawState)) { foreach ($this->getStateCasts() as $stateCast) { $rawState = $stateCast->set($rawState); } $this->rawState($rawState); } return parent::callAfterStateUpdated($shouldBubbleToParents); } /** * @param array | Closure | null $colors */ public function textColors(array | Closure | null $colors): static { $this->textColors = $colors; return $this; } /** * @return array */ public function getTextColors(): array { $textColors = $this->evaluate($this->textColors) ?? $this->getContentAttribute()?->getTextColors() ?? TextColor::getDefaults(); return Arr::mapWithKeys( $textColors, fn (string | TextColor $color, string $name): array => [$name => ($color instanceof TextColor) ? $color : TextColor::make($color, $name)], ); } /** * @return array */ public function getTextColorsForJs(): array { return array_map( fn (TextColor $color): array => [ 'color' => $color->getColor(), 'darkColor' => $color->getDarkColor(), ], $this->getTextColors(), ); } public function customTextColors(bool | Closure | null $condition = true): static { $this->hasCustomTextColors = $condition; return $this; } public function hasCustomTextColors(): bool { return (bool) ($this->evaluate($this->hasCustomTextColors) ?? $this->getContentAttribute()?->hasCustomTextColors() ?? false); } public function resizableImages(bool | Closure | null $condition = true): static { $this->hasResizableImages = $condition; return $this; } public function hasResizableImages(): bool { return (bool) $this->evaluate($this->hasResizableImages); } public function hasFileAttachmentsByDefault(): bool { return $this->hasToolbarButton('attachFiles'); } public function toEmbeddedHtml(): string { $groupedCustomBlocks = $this->getGroupedCustomBlocks(); $id = $this->getId(); $isDisabled = $this->isDisabled(); $label = $this->getLabel(); $livewireKey = $this->getLivewireKey(); $key = $this->getKey(); $mergeTags = $this->getMergeTags(); $statePath = $this->getStatePath(); $mentions = $this->getMentionsForJs(); $toolbarButtons = $this->getToolbarButtons(); $tools = $this->getTools(); $floatingToolbars = $this->getFloatingToolbars(); $linkProtocols = $this->getLinkProtocols(); $fileAttachmentsMaxSize = $this->getFileAttachmentsMaxSize(); $fileAttachmentsAcceptedFileTypes = $this->getFileAttachmentsAcceptedFileTypes(); $wrapperAttributes = $this->getExtraAttributeBag() ->merge(['x-cloak' => true], escape: false) ->class(['fi-fo-rich-editor']); $deleteIconHtml = generate_icon_html(Heroicon::Trash, alias: FormsIconAlias::COMPONENTS_RICH_EDITOR_PANELS_CUSTOM_BLOCK_DELETE_BUTTON); $editIconHtml = generate_icon_html(Heroicon::PencilSquare, alias: FormsIconAlias::COMPONENTS_RICH_EDITOR_PANELS_CUSTOM_BLOCK_EDIT_BUTTON); ob_start(); ?>

, statePath: , textColors: getTextColorsForJs()) ?>, uploadingFileMessage: getUploadingFileMessage()) ?>, })" x-bind:class="{ 'fi-fo-rich-editor-uploading-file': isUploadingFile, }" wire:ignore wire:key="." >

toHtml() ?> getUploadingFileMessage()) ?>

getExtraInputAttributeBag()->class(['fi-fo-rich-editor-main'])->toHtml() ?>>

$buttons) { ?>

$groupBlocks) { ?>

$tagLabel) { ?>

wrapEmbeddedHtml( $this->wrapInputHtml( $slotHtml, attributes: $wrapperAttributes, ), labelTag: 'div', ); } }