Merge pull request #14419 from Plytas/4.x

Added markdown extensions support
filamentphp · Feb 2, 2025 · 8883418 · 8883418
2 parents 31c1e16 + 40f31e8
commit 8883418
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 4 deletions.
diff --git a/packages/forms/resources/views/components/markdown-editor.blade.php b/packages/forms/resources/views/components/markdown-editor.blade.php
@@ -10,7 +10,7 @@
         <div
             class="fi-fo-markdown-editor fi-disabled prose dark:prose-invert block w-full max-w-none rounded-lg bg-gray-50 px-3 py-3 text-gray-500 ring-1 shadow-xs ring-gray-950/10 sm:text-sm dark:bg-transparent dark:text-gray-400 dark:ring-white/10"
         >
-            {!! str($getState())->markdown()->sanitizeHtml() !!}
+            {!! str($getState())->sanitizeHtml()->markdown($getCommonMarkOptions(), $getCommonMarkExtensions()) !!}
         </div>
     @else
         <x-filament::input.wrapper

diff --git a/packages/forms/src/Components/MarkdownEditor.php b/packages/forms/src/Components/MarkdownEditor.php
@@ -3,10 +3,12 @@
 namespace Filament\Forms\Components;
 
 use Closure;
+use Filament\Support\Concerns\CanConfigureCommonMark;
 use Filament\Support\Concerns\HasExtraAlpineAttributes;
 
 class MarkdownEditor extends Field implements Contracts\CanBeLengthConstrained, Contracts\HasFileAttachments
 {
+    use CanConfigureCommonMark;
     use Concerns\CanBeLengthConstrained;
     use Concerns\HasFileAttachments;
     use Concerns\HasMaxHeight;

diff --git a/packages/infolists/src/Components/Concerns/CanFormatState.php b/packages/infolists/src/Components/Concerns/CanFormatState.php
@@ -5,6 +5,7 @@
 use Closure;
 use Filament\Infolists\Components\TextEntry;
 use Filament\Schemas\Schema;
+use Filament\Support\Concerns\CanConfigureCommonMark;
 use Filament\Support\Contracts\HasLabel as LabelInterface;
 use Filament\Support\Enums\ArgumentValue;
 use Illuminate\Contracts\Support\Htmlable;
@@ -15,6 +16,8 @@
 
 trait CanFormatState
 {
+    use CanConfigureCommonMark;
+
     protected ?Closure $formatStateUsing = null;
 
     protected int | Closure | null $characterLimit = null;
@@ -378,7 +381,7 @@ public function formatState(mixed $state): mixed
         }
 
         if ($isHtml && $this->isMarkdown()) {
-            $state = Str::markdown($state);
+            $state = Str::markdown($state, $this->getCommonMarkOptions(), $this->getCommonMarkExtensions());
         }
 
         $prefix = $this->getPrefix();

diff --git a/packages/support/src/Concerns/CanConfigureCommonMark.php b/packages/support/src/Concerns/CanConfigureCommonMark.php
@@ -0,0 +1,55 @@
+<?php
+
+namespace Filament\Support\Concerns;
+
+use Closure;
+use League\CommonMark\Extension\ExtensionInterface;
+
+trait CanConfigureCommonMark
+{
+    /**
+     * @var array<string, mixed> | Closure | null
+     */
+    protected array | Closure | null $commonMarkOptions = null;
+
+    /**
+     * @var array<array-key, ExtensionInterface> | Closure | null
+     */
+    protected array | Closure | null $commonMarkExtensions = null;
+
+    /**
+     * @param  array<string, mixed> | Closure | null  $commonMarkOptions
+     */
+    public function commonMarkOptions(array | Closure | null $commonMarkOptions): static
+    {
+        $this->commonMarkOptions = $commonMarkOptions;
+
+        return $this;
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function getCommonMarkOptions(): array
+    {
+        return $this->evaluate($this->commonMarkOptions) ?? [];
+    }
+
+    /**
+     * @param  array<array-key, ExtensionInterface> | Closure | null  $commonMarkExtensions
+     */
+    public function commonMarkExtensions(array | Closure | null $commonMarkExtensions): static
+    {
+        $this->commonMarkExtensions = $commonMarkExtensions;
+
+        return $this;
+    }
+
+    /**
+     * @return array<array-key, ExtensionInterface>
+     */
+    public function getCommonMarkExtensions(): array
+    {
+        return $this->evaluate($this->commonMarkExtensions) ?? [];
+    }
+}
diff --git a/packages/tables/src/Columns/Concerns/CanFormatState.php b/packages/tables/src/Columns/Concerns/CanFormatState.php
@@ -3,6 +3,7 @@
 namespace Filament\Tables\Columns\Concerns;
 
 use Closure;
+use Filament\Support\Concerns\CanConfigureCommonMark;
 use Filament\Support\Contracts\HasLabel as LabelInterface;
 use Filament\Support\Enums\ArgumentValue;
 use Filament\Tables\Columns\TextColumn;
@@ -15,6 +16,8 @@
 
 trait CanFormatState
 {
+    use CanConfigureCommonMark;
+
     protected ?Closure $formatStateUsing = null;
 
     protected int | Closure | null $characterLimit = null;
@@ -382,7 +385,7 @@ public function formatState(mixed $state): mixed
         }
 
         if ($isHtml && $this->isMarkdown()) {
-            $state = Str::markdown($state);
+            $state = Str::markdown($state, $this->getCommonMarkOptions(), $this->getCommonMarkExtensions());
         }
 
         $prefix = $this->getPrefix();

diff --git a/packages/tables/src/Columns/Summarizers/Concerns/CanFormatState.php b/packages/tables/src/Columns/Summarizers/Concerns/CanFormatState.php
@@ -3,6 +3,7 @@
 namespace Filament\Tables\Columns\Summarizers\Concerns;
 
 use Closure;
+use Filament\Support\Concerns\CanConfigureCommonMark;
 use Filament\Support\Enums\ArgumentValue;
 use Filament\Tables\Columns\Summarizers\Summarizer;
 use Filament\Tables\Table;
@@ -13,6 +14,8 @@
 
 trait CanFormatState
 {
+    use CanConfigureCommonMark;
+
     protected ?Closure $formatStateUsing = null;
 
     protected string | Closure | null $placeholder = null;
@@ -157,7 +160,7 @@ public function formatState(mixed $state): mixed
         }
 
         if ($isHtml && $this->isMarkdown()) {
-            $state = Str::markdown($state);
+            $state = Str::markdown($state, $this->getCommonMarkOptions(), $this->getCommonMarkExtensions());
         }
 
         $prefix = $this->getPrefix();