Skip to content

Commit 4f8e794

Browse files
committed
Rename columnField to columnIdentifier in kanban-board-page.stub and update README for clarity
1 parent d87517a commit 4f8e794

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ composer require relaticle/flowforge
2929
php artisan flowforge:make-board TaskBoard --model=Task
3030
```
3131

32-
That's it! Add the page to your Filament panel and you have a working Kanban board.
32+
That's it! Add the generated page to your Filament panel and you have a working Kanban board.
3333

3434
<details>
3535
<summary>📋 <strong>Show complete example</strong></summary>
@@ -59,7 +59,7 @@ class TaskBoard extends BoardPage
5959
return $board
6060
->query($this->getEloquentQuery())
6161
->cardTitle('title')
62-
->columnField('status')
62+
->columnIdentifier('status')
6363
->columns([
6464
Column::make('todo')->label('To Do')->color('gray'),
6565
Column::make('in_progress')->label('In Progress')->color('blue'),
@@ -150,7 +150,7 @@ public function board(Board $board): Board
150150
return $board
151151
->query($this->getEloquentQuery())
152152
->cardTitle('title')
153-
->columnField('status')
153+
->columnIdentifier('status')
154154
->columns([
155155
Column::make('backlog')->label('Backlog'),
156156
Column::make('active')->label('Active'),
@@ -172,7 +172,7 @@ public function board(Board $board): Board
172172
return $board
173173
->query($this->getEloquentQuery())
174174
->cardTitle('title')
175-
->columnField('status')
175+
->columnIdentifier('status')
176176
->columns([...])
177177
->columnActions([
178178
CreateAction::make()
@@ -211,10 +211,10 @@ use Relaticle\Flowforge\Property;
211211
| Method | Description | Required |
212212
|--------|-------------|----------|
213213
| `cardTitle(string)` | Field used for card titles ||
214-
| `columnField(string)` | Field that determines column placement ||
214+
| `columnIdentifier(string)` | Field that determines column placement ||
215215
| `columns(array)` | Define board columns ||
216216
| `query(Builder)` | Set the data source ||
217-
| `defaultSort(string)` | Field used for drag & drop ordering | |
217+
| `defaultSort(string, ?string)` | Field and optional direction for drag & drop ordering | |
218218
| `cardProperties(array)` | Additional fields to display | |
219219
| `columnActions(array)` | Actions for column headers | |
220220
| `cardActions(array)` | Actions for individual cards | |
@@ -273,7 +273,7 @@ use Relaticle\Flowforge\Property;
273273

274274
## Contributing
275275

276-
Contributions welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
276+
Contributions are welcome! Please feel free to submit a Pull Request.
277277

278278
## License
279279

stubs/kanban-board-page.stub

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class {{ class }} extends BoardPage
1919
return $board
2020
->query($this->getEloquentQuery())
2121
->cardTitle('{{ titleField }}')
22-
->columnField('{{ statusField }}')
22+
->columnIdentifier('{{ statusField }}')
2323
->defaultSort('order_column')
2424
->columns([
2525
Column::make('todo')->label('To Do')->color('gray'),

0 commit comments

Comments
 (0)