Merge branch 'pr/14416' into 3.x

filamentphp · Oct 8, 2024 · ef7729a · ef7729a
2 parents ac74418 + b53c62b
commit ef7729a
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 0 deletions.
diff --git a/packages/forms/docs/03-fields/10-rich-editor.md b/packages/forms/docs/03-fields/10-rich-editor.md
@@ -67,3 +67,14 @@ RichEditor::make('content')
     ->fileAttachmentsDirectory('attachments')
     ->fileAttachmentsVisibility('private')
 ```
+
+## Disabling Grammarly checks
+
+If the user has Grammarly installed and you would like to it from analyzing the contents of the editor, you can use the `disableGrammarly()` method:
+
+```php
+use Filament\Forms\Components\RichEditor;
+
+RichEditor::make('content')
+    ->disableGrammarly()
+```
diff --git a/packages/forms/resources/views/components/rich-editor.blade.php b/packages/forms/resources/views/components/rich-editor.blade.php
@@ -501,6 +501,11 @@ class="trix-button trix-button--dialog"
                     @endif
                     x-ref="trix"
                     wire:ignore
+                    @if ($isGrammarlyDisabled())
+                        data-gramm="false"
+                        data-gramm_editor="false"
+                        data-enable-grammarly="false"
+                    @endif
                     {{
                         $getExtraInputAttributeBag()->class([
                             'prose min-h-[theme(spacing.48)] max-w-none !border-none px-3 py-1.5 text-base text-gray-950 dark:prose-invert focus-visible:outline-none dark:text-white sm:text-sm sm:leading-6',

diff --git a/packages/forms/src/Components/Concerns/CanDisableGrammarly.php b/packages/forms/src/Components/Concerns/CanDisableGrammarly.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace Filament\Forms\Components\Concerns;
+
+use Closure;
+
+trait CanDisableGrammarly
+{
+    protected bool | Closure $isGrammarlyDisabled = false;
+
+    public function disableGrammarly(bool | Closure $condition = true): static
+    {
+        $this->isGrammarlyDisabled = $condition;
+
+        return $this;
+    }
+
+    public function isGrammarlyDisabled(): bool
+    {
+        return (bool) $this->evaluate($this->isGrammarlyDisabled);
+    }
+}
diff --git a/packages/forms/src/Components/Field.php b/packages/forms/src/Components/Field.php
@@ -7,6 +7,7 @@ class Field extends Component implements Contracts\HasHintActions, Contracts\Has
     use Concerns\CanBeAutofocused;
     use Concerns\CanBeMarkedAsRequired;
     use Concerns\CanBeValidated;
+    use Concerns\CanDisableGrammarly;
     use Concerns\HasExtraFieldWrapperAttributes;
     use Concerns\HasHelperText;
     use Concerns\HasHint;