README

Filament Ace Editor (Supporting Filament v5)

A powerful Ace Editor implementation for Filament v5 Forms and Infolists with syntax highlighting, themes, autocompletion, and read-only mode support.

Requirements

• PHP 8.2+
• Laravel 12.x
• Filament 5.x

Installation

You can install the package via composer:

composer require iperamuna/filament-ace-editor

The package will automatically detect your Filament version and work seamlessly with your installation.

Usage

Basic Form Field

use Iperamuna\FilamentAceEditor\AceEditor;

AceEditor::make('content')
    ->label('Code Editor')
    ->mode('php')
    ->theme('monokai')
    ->minLines(20)
    ->maxLines(50);

Advanced Configuration

AceEditor::make('script_content')
    ->label('Shell Script')
    ->hint(fn ($state) => new HtmlString(
        view('components.copy-button', ['content' => $state])->render()
    ))
    ->mode('sh')
    ->theme('monokai')
    ->minLines(20)
    ->maxLines(30)
    // Toggleable edit/read-only mode
    ->toggleable(true)
    // Control initial read-only state
    ->defaultReadOnly(fn ($livewire) => $livewire->getRecord() !== null)
    // Add extensions
    ->addExtension('searchbox')
    // Custom editor options
    ->options([
        'tabSize' => 2,
        'showPrintMargin' => false,
        'enableBasicAutocompletion' => true,
    ]);

Infolist Entry

use Iperamuna\FilamentAceEditor\AceEditorEntry;

AceEditorEntry::make('content')
    ->label('Script Content')
    ->mode('sh')
    ->theme('monokai')
    ->minLines(15)
    ->maxLines(50);

Key Features

🔒 Read-Only Mode Control

The defaultReadOnly() method helps prevent unwanted edits, especially useful when editing existing records. You can control it with a boolean or closure:

// Always read-only initially
AceEditor::make('config')
    ->defaultReadOnly(true);

// Read-only when editing existing records, editable when creating new ones
AceEditor::make('script_content')
    ->defaultReadOnly(fn ($livewire) => $livewire->getRecord() !== null);

// Custom logic based on user permissions
AceEditor::make('sensitive_data')
    ->defaultReadOnly(fn ($livewire) => !auth()->user()->can('edit', $livewire->getRecord()));

// Disable read-only mode entirely
AceEditor::make('content')
    ->defaultReadOnly(false);

Example Use Case: When a form is in create mode, the editor automatically opens in edit mode. When viewing or editing an existing record, it starts in read-only mode to prevent accidental changes. Users can toggle to edit mode when needed.

🎨 Theme Support

// Light theme for day work
AceEditor::make('content')
    ->theme('github');

// Dark theme for night owls
AceEditor::make('content')
    ->theme('monokai');

Available themes include: monokai, github, tomorrow, twilight, solarized_light, solarized_dark, and many more.

🔧 Toggleable Edit Mode

Allow users to switch between read-only and edit modes:

AceEditor::make('content')
    ->toggleable(true)  // Shows EDIT/DONE toggle button
    ->defaultReadOnly(true);  // Starts in read-only mode

📏 Flexible Sizing

AceEditor::make('content')
    ->minLines(10)   // Minimum editor height
    ->maxLines(50);  // Maximum editor height

🧩 Extensions Support

AceEditor::make('content')
    ->addExtension('searchbox')
    ->addExtension('beautify')
    ->addExtension('language_tools');

Configuration

Publish the configuration file to customize defaults:

php artisan vendor:publish --tag="filament-ace-editor-config"

This creates config/filament-ace-editor.php:

return [
    'base_url' => 'https://cdnjs.cloudflare.com/ajax/libs/ace/1.32.7',
    
    'editor_options' => [
        'enableBasicAutocompletion' => true,
        'enableLiveAutocompletion' => true,
        'enableSnippets' => true,
        'showPrintMargin' => true,
        'highlightActiveLine' => true,
        'displayIndentGuides' => true,
    ],
    
    'enabled_extensions' => [
        'language_tools',
        'beautify',
        'searchbox',
    ],
];

Available Methods

Supported Languages

Ace Editor supports over 110 programming languages and markup formats. Common modes include:

Programming Languages:

• php, python, javascript, typescript, java, c_cpp, ruby, go, rust

Web Technologies:

• html, css, scss, less, json, xml, yaml

Data & Config:

• sql, mysql, pgsql, ini, toml, dockerfile

Scripting:

• sh (Shell/Bash), powershell, batchfile

Markup:

• markdown, latex, asciidoc

See the Ace Editor documentation for the complete list of supported modes.

Publishing

Publish the views for customization:

php artisan vendor:publish --tag="filament-ace-editor-views"

Publish the configuration:

php artisan vendor:publish --tag="filament-ace-editor-config"

Supported Features

This package supports most powerful features from Ace Editor:

• ✅ Syntax highlighting for 110+ languages
• ✅ Multiple themes (light and dark)
• ✅ Code autocompletion
• ✅ Search and replace
• ✅ Code folding
• ✅ Multiple cursors
• ✅ Line numbering
• ✅ Automatic indentation
• ✅ Read-only mode with toggle
• ✅ Customizable key bindings
• ✅ Extensions support

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• Indunil Peramuna
• All Contributors

License

The MIT License (MIT). Please see License File for more information.