- How do I install the filament-yaml-editor package?
- Install it with Composer using composer require jeffersongoncalves/filament-yaml-editor. Laravel package discovery registers the service provider automatically, so no manual provider entry is usually needed. After that you can reference the YAML editor field class directly in your Filament form schemas.
- Which Laravel and Filament versions does filament-yaml-editor support?
- The package is built for Laravel applications that use Filament admin panels, and it is distributed as a standard Filament form field. Exact Laravel and Filament version constraints are declared in the package composer.json, so check that file on Packagist or the GitHub repository before upgrading a major Filament release. Pinning compatible versions in your own composer.json avoids surprises during updates.
- How do I add a YAML editor field to a Filament resource form?
- Import the YAML editor field class and add it to your resource form schema like any other Filament component, for example YamlEditor::make('config'). Filament will render a syntax-highlighted editor instead of a plain textarea and store the submitted YAML string in the corresponding model attribute. You can combine it with the usual Filament layout components such as sections and grids.
- Can I use the YAML editor on Filament settings pages or custom forms, not just resources?
- Yes. Because it is a Filament form component rather than a resource-specific feature, you can use it in any Filament form, including custom pages, settings pages, and Livewire-backed forms that use Filament's form builder. The same field configuration and validation rules apply wherever the form is rendered.
- Does filament-yaml-editor support validation and error feedback?
- Yes, the field integrates with Filament's validation system so validation errors are shown with the rest of your form errors. You can attach standard Laravel validation rules such as required or string to the field, and add custom rules to check that the submitted content parses as valid YAML. Error messages appear inline in the form, keeping the editing experience consistent with other Filament fields.
- Can I configure the YAML editor options, such as size or appearance?
- The package exposes configurable editor options so you can adjust the editing experience to fit your admin panel. Typical adjustments include the editor height and other field-level settings passed through the Filament field API. Refer to the package README for the exact chainable methods and defaults available in your installed version.
- How do I test a Filament form that uses the YAML editor field?
- Write Livewire tests against the Filament page or form and use Filament's form testing helpers, such as fillForm, to submit a YAML string into the field. Assert that valid YAML saves without errors and that invalid YAML triggers the expected validation failure. Because the field stores plain YAML text, you can assert against the resulting model attribute or saved file contents.
- Is it safe to edit production YAML configuration files through the admin panel?
- It can be convenient, but treat it carefully: restrict access to trusted administrators, validate YAML before saving, and keep backups or version control for any configuration files that the editor can change. Avoid exposing files that contain secrets or credentials in a web-editable form. For critical configuration, prefer a staged workflow where changes are reviewed before deployment.
- What are the alternatives to filament-yaml-editor?
- The simplest alternative is a Filament Textarea or TextInput field, which works for small YAML snippets but offers no syntax highlighting or structure awareness. Other options include general-purpose code editor fields for Filament or custom CodeMirror and Monaco integrations, which may be heavier but support multiple languages. This package is a focused choice when YAML editing is the main requirement and you want a lightweight setup.
- Is filament-yaml-editor actively maintained, and where do I report issues?
- The package is published on GitHub at jeffersongoncalves/filament-yaml-editor, where you can review commits, releases, and open issues to gauge current maintenance activity. Report bugs or feature requests through the repository's issue tracker with your Laravel and Filament versions included. Checking the repository before adopting it in a long-lived project is a good habit for any smaller Composer package.