Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caendesilva/filament-simple-highlight-field-plugin
Adds a simple read-only Highlight.js pseudo-field to FilamentPHP
https://github.com/caendesilva/filament-simple-highlight-field-plugin
Last synced: about 1 month ago
JSON representation
Adds a simple read-only Highlight.js pseudo-field to FilamentPHP
- Host: GitHub
- URL: https://github.com/caendesilva/filament-simple-highlight-field-plugin
- Owner: caendesilva
- License: mit
- Created: 2022-09-03T17:15:07.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-03T19:18:33.000Z (about 1 year ago)
- Last Synced: 2024-04-03T23:20:38.888Z (2 months ago)
- Language: PHP
- Homepage: https://filamentphp.com/plugins/simple-highlight-field
- Size: 86.9 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Lists
- awesome-filament - caendesilva/filament-simple-highlight-field-plugin - Adds a simple read-only Highlight.js pseudo-field. (Fields)
README
# desilva/filament-simple-highlight-field
[](https://packagist.org/packages/desilva/filament-simple-highlight-field)
[](https://packagist.org/packages/desilva/filament-simple-highlight-field)
## Adds a simple read-only Highlight.js pseudo-field to FilamentPHP
Adds a simple form field that renders a read-only Highlight.js code block for FilamentPHP. The plugin is new and may be unstable and contain bugs. PRs and issue reports are welcome.
## Installation
You can install the package via composer:
```bash
composer require desilva/filament-simple-highlight-field
```
This package supports Laravel 9 and Laravel 10.
## Usage
Simply use the component as you'd use any other Filament field. It's especially perfect for the resource view page where it blends right in.
```php
use Desilva\FilamentSimpleHighlightField\HighlightField;
class FileResource extends Resource
{
public static function form(Form $form): Form
{
return $form
->schema([
HighlightField::make('contents')
->columnSpan('full'),
]);
}
}
```
## Roadmap
- [x] Add option to customize the theme
- [x] Dark mode support (doesn't work with custom theme)
- [ ] Add method chain to specify the language
## Configuration
You can publish the config file with:
```bash
php artisan vendor:publish --tag="filament-simple-highlight-field-config"
```
This is the contents of the published config file:
```php
return [
// By default, the plugin will load serve the assets from Filament. You can uncomment the following to specify
// a custom theme that will then be loaded from the Highlight.js CDN. See https://highlightjs.org/static/demo
// 'theme' => 'nord',
];
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="filament-simple-highlight-field-views"
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Contributing is pretty chill and is highly appreciated! Just send a PR and/or create an issue!
## Security Vulnerabilities
Please review my [General Security Policy](https://git.desilva.se/security/) on how to report security vulnerabilities.
## Credits
- [Caen De Silva](https://github.com/caendesilva)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.