Demo Get Started Join the community
API Documentation
Tutorials
01. Installation instructions 02. Example App 03. Adding resources 04. Customize resources 05. Customize actions 06. Writing your own Components 07. Customize dashboard 08. Role-Based Access Control 09. Internationalization (i18n) 10. Content Management System

Interface

ResourceJSON

ResourceJSON

Resource object accessible on the fronted

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

Members

Array.<ActionJSON>

# actions

All actions - whether they are available or not.

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

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

Array.<PropertyJSON>

# filterProperties

Properties which should be visible on the filter

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

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

string

# id

Unique Id of a resource

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

Array.<PropertyJSON>

# listProperties

Properties which should be visible on the list

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

string

# name

Resource name

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

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

Array.<ActionJSON>

# resourceActions

Actions available for entire resource with type: resource

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

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

PropertyJSON

# titleProperty

Property which should be treated as a Main property

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