Skip to content

Commit 74b20fd

Browse files
authored
Further document the config file
1 parent aa22ffb commit 74b20fd

File tree

1 file changed

+53
-1
lines changed

1 file changed

+53
-1
lines changed

config/filament-fabricator.php

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,86 @@
33
// config for Z3d0X/FilamentFabricator
44
return [
55
'routing' => [
6+
/**
7+
* Whether routing should be automatically handled.
8+
* Disable if you want finer and manual control over how the routing to your pages is done.
9+
*/
610
'enabled' => true,
11+
12+
/**
13+
* The prefix to use for all pages' routes.
14+
* Leave to null if you don't want them to have a prefix.
15+
* A prefix set to '/pages' means that a page of slug 'page-1'
16+
* would be accessed through `/pages/page-1` if routing is enabled.
17+
*/
718
'prefix' => null, // /pages
819
],
920

1021
'layouts' => [
22+
/**
23+
* The base namespace for all your
24+
* filament-fabricator page layouts
25+
*/
1126
'namespace' => 'App\\Filament\\Fabricator\\Layouts',
27+
28+
/**
29+
* The path to your layouts (folder or glob)
30+
* This is used when auto-registering them
31+
*/
1232
'path' => app_path('Filament/Fabricator/Layouts'),
33+
34+
/**
35+
* A list of layout classes you want to manually register
36+
* in addition to those that are auto-registered
37+
*/
1338
'register' => [
1439
//
1540
],
1641
],
1742

1843
'page-blocks' => [
44+
/**
45+
* The base namespace for all your filament-fabricator page blocks
46+
*/
1947
'namespace' => 'App\\Filament\\Fabricator\\PageBlocks',
48+
49+
/**
50+
* The path to your blocks (folder or glob)
51+
* This is used when auto-registering them
52+
*/
2053
'path' => app_path('Filament/Fabricator/PageBlocks'),
54+
55+
/**
56+
* A list of block classes you want to manually register
57+
* in addition to those that are auto-registered
58+
*/
2159
'register' => [
2260
//
2361
],
2462
],
2563

64+
/**
65+
* The middleware(s) to apply to your pages when routing is enabled
66+
*/
2667
'middleware' => [
2768
'web',
2869
],
2970

71+
/**
72+
* The page model to be used by the package.
73+
* Replace this if you ever extend it
74+
*/
3075
'page-model' => \Z3d0X\FilamentFabricator\Models\Page::class,
3176

77+
/**
78+
* The page filament resource to be used by the package.
79+
* Replace this if you ever extend it
80+
*/
3281
'page-resource' => \Z3d0X\FilamentFabricator\Resources\PageResource::class,
3382

83+
/**
84+
* Whether you want to have a view page as part of your PageResource
85+
*/
3486
'enable-view-page' => false,
3587

3688
/**
@@ -47,7 +99,7 @@
4799
*/
48100
'hook-to-commands' => true,
49101

50-
/*
102+
/**
51103
* This is the name of the table that will be created by the migration and
52104
* used by the above page-model shipped with this package.
53105
*/

0 commit comments

Comments
 (0)