Interface

ResourceJSON

ResourceJSON

Resource object accessible on the fronted

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 5

Members

Type: Array.<ActionJSON>

# actions

All actions - whether they are available or not.

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 43

Type: Array.<PropertyJSON>

# editProperties

Properties which should be visible on the edit view

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 53

Type: Array.<PropertyJSON>

# filterProperties

Properties which should be visible on the filter

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 63

Type: string | null

# href

url to a resource list action. If null - resource should not be seen in the sidebar.

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 21

Type: string

# id

Unique Id of a resource

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 11

Type: Array.<PropertyJSON>

# listProperties

Properties which should be visible on the list

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 48

Type: string

# name

Resource name

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 16

Type: object | null

# parent

Resource parent - visible on the sidebar

Properties:

Name	Type	Description
`name`	string	Parent name
`icon`	string	Parent icon

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 26

Type: Record.<string, PropertyJSON>

# properties

Map of all properties inside the resource. It also contains nested properties. So this is the easies way of getting any property you like from a resource.

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 68

Type: Array.<ActionJSON>

# resourceActions

Actions available for entire resource with type: resource

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 38

Type: Array.<PropertyJSON>

# showProperties

Properties which should be visible on the show view

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 58

Type: PropertyJSON

# titleProperty

Property which should be treated as a Main property

View Source admin-bro/src/backend/decorators/resource-json.interface.ts, line 33