Skip to content

Commit a54bfb3

Browse files
committed
Update README
1 parent 9300dda commit a54bfb3

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,36 @@ Hi! We are a web development agency from Nijmegen in the Netherlands and we use
1212
## About the package
1313

1414
This package provides a simple - yet extendable - way to add configurable fields to your Filament resources. We provide you all Filament Form fields and a way to add your own fields.
15-
[
15+
16+
## Features
17+
18+
- 🎯 **Easy Integration**: Seamlessly integrates with your Filament resources
19+
- 🔧 **Configurable Fields**: Add and manage custom fields for your models
20+
- 🎨 **Built-in Field Types**: Includes common Filament form fields like:
21+
- Text
22+
- Textarea
23+
- Rich Text Editor
24+
- Select
25+
- Checkbox
26+
- Checkbox List
27+
- Key-Value
28+
- Radio
29+
- Toggle
30+
- Color Picker
31+
- DateTime
32+
- Tags
33+
-**Extensible**: Create your own custom field types
34+
- 🔄 **Data Mutation**: Hooks to modify field data before filling forms or saving
35+
- 🏢 **Multi-tenant Support**: Built-in support for multi-tenant applications
36+
- 🛡️ **Type Safe**: Leverages PHP enums for field types
37+
38+
This package is perfect for scenarios where you need to:
39+
- Add dynamic custom fields to your models
40+
- Allow users to configure form fields through the admin panel
41+
- Build flexible content management systems
42+
- Create customizable settings pages
43+
44+
1645
## Installation
1746

1847
You can install the package via composer:
@@ -90,6 +119,22 @@ class EditSetting extends EditRecord
90119
}
91120
```
92121

122+
### Add resources as options for select fields
123+
124+
To add resources as options for select fields, you can add them to the `filament-fields.select.resource_options` config array.
125+
126+
```php
127+
return [
128+
// ...
129+
130+
'select' => [
131+
'resource_options' => [
132+
App\Filament\Resources\ContentResource::class,
133+
]
134+
]
135+
];
136+
```
137+
93138
### Creating your own fields
94139

95140
...

0 commit comments

Comments
 (0)