Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/creagia/filament-code-field
https://github.com/creagia/filament-code-field
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/creagia/filament-code-field
- Owner: creagia
- License: mit
- Created: 2022-11-15T16:07:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-31T09:33:18.000Z (about 2 months ago)
- Last Synced: 2024-10-31T10:09:46.954Z (about 2 months ago)
- Language: PHP
- Size: 1.54 MB
- Stars: 55
- Watchers: 6
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-filament - creagia/filament-code-field - A CodeMirror powered code field for the Filamentphp admin panel and form builder. (Fields)
README
# Filamentphp code field
[](https://packagist.org/packages/creagia/filament-code-field)
[](https://github.com/creagia/filament-code-field/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/creagia/filament-code-field/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/creagia/filament-code-field)
A [CodeMirror](https://codemirror.net/) powered code field for the Filamentphp admin panel and form builder.
With code autocompletion, light/dark modes, multiple languages, read-only mode and more.
Check screenshots and read more about the package in our [blog post](https://creagia.com/blog/a-code-field-for-the-filamentphp-admin-panel-and-form-builder).
## Installation
**Latest version of the package requires Filament 3 and Laravel 11.**
You can install the package via composer:
```bash
composer require creagia/filament-code-field
```
### ⚠️ Use version `2.x.x` for Filament 3 and Laravel 10 support ⚠️
```bash
composer require "creagia/filament-code-field:^2.0.0"
```
### ⚠️ Use version `1.x.x` for Filament 2 support ⚠️
```bash
composer require "creagia/filament-code-field:^1.0.0"
```
## Usage
Creating a code field is straightforward, just instantiate the `CodeField` class for the desired property.
```php
use Creagia\FilamentCodeField\CodeField;
return $form
->schema([
CodeField::make('my_json'),
// other fields
]);
```
### Choosing another language
By default, a JSON field will be created.
If you want to create a field for another supported language, you can do so with the `setLanguage()` and helper methods.
Supported languages: JSON, PHP, HTML, XML and JavaScript (JS).
```php
use Creagia\FilamentCodeField\CodeField;
return $form
->schema([
CodeField::make('js_code')
->setLanguage(CodeField::JS),
// or
->jsField()
]);
```
### Disabling code completion
By default, the field comes with code completion/suggestions enabled.
For disabling this feature, use the `disableAutocompletion()`.
```php
use Creagia\FilamentCodeField\CodeField;
return $form
->schema([
CodeField::make('js_code')
->htmlField()
->disableAutocompletion(),
]);
```
### Line numbers
Line numbers can be enabled using the `withLineNumbers()` method.
```php
use Creagia\FilamentCodeField\CodeField;
return $form
->schema([
CodeField::make('json')
->withLineNumbers(),
]);
```
### Read-only mode
Adding the Filamentphp `disabled()` method will make the code field read-only.
```php
use Creagia\FilamentCodeField\CodeField;
return $form
->schema([
CodeField::make('json')
->disabled(),
]);
```
### Filamentphp methods
Of course, the code field extends the `Filamentphp` field class, and you can use all the usual methods such as `label()`.
```php
use Creagia\FilamentCodeField\CodeField;
return $form
->schema([
CodeField::make('json')
->label('Your JSON data')
->hint('Top right corner info')
->helper('More info after the text field')
// more methods
,
]);
```