Options for given resource
Usage with TypeScript
import { ResourceOptions } from 'admin-bro'
Members
# actions Optional
List of all actions along with their options
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
show |
Partial.<Action.<RecordActionResponse>> |
<optional> |
|
edit |
Partial.<Action.<RecordActionResponse>> |
<optional> |
|
delete |
Partial.<Action.<RecordActionResponse>> |
<optional> |
|
bulkDelete |
Partial.<Action.<BulkActionResponse>> |
<optional> |
|
new |
Partial.<Action.<RecordActionResponse>> |
<optional> |
|
list |
Partial.<Action.<ListActionResponse>> |
<optional> |
|
search |
Partial.<Action.<SearchActionResponse>> |
<optional> |
|
{...} |
Partial.<Action.<ActionResponse>> |
# href Optional
Where resource link in sidebar should redirect. Default to the list action.
# id Optional
Unique id of a resource.
So let's suppose that you connected 2 databases to AdminBro. Both of them have the same collection: 'users'. In this case AdminBro wont be able to distinguish them. In this case changing Id of one of the resources helps to solve this issue.
# navigation Optional
Navigation option saying under which resource should be nested in sidebar. Default to the database name.
You have couple of options:
- when you give both name and icon - your resource will be nested under this menu.
- when you set it to null - resource will be top level, but without the icon
- finally you can set the icon but leave name as
null. In such case resource will be top level and it will have an icon.
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string | null |
<optional> |
|
icon |
string |
<optional> |
# parent Optional
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string | null |
<optional> |
|
icon |
string |
<optional> |
- Deprecated:
- in favour of ResourceOptions.navigation
View Source admin-bro/src/backend/decorators/resource/resource-options.interface.ts, line 92
# sort Optional
Default sort property and direction.
Properties:
| Name | Type | Description |
|---|---|---|
direction |
'asc' | 'desc' | |
sortBy |
string |
Type Definitions
# HrefContext
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
h |
ViewHelpers | view helpers |
|
resource |
BaseResource | Resource on which href has been invoked. |
|
currentAdmin |
CurrentAdmin |
<optional> |
Currently logged in admin |
# HrefFunction(context)
Function returning string or string
Parameters:
| Name | Type | Description |
|---|---|---|
context |
HrefContext |
