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

Interface

ResourceJSON

ResourceJSON

Resource object accessible on the fronted

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 6

Members

Array.<ActionJSON>

# actions

All actions - whether they are available or not.

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 45

Array.<BasePropertyJSON>

# editProperties

Properties which should be visible on the edit view

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 55

Array.<BasePropertyJSON>

# filterProperties

Properties which should be visible on the filter

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 65

string | null

# href

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

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 22

string

# id

Unique Id of a resource

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 12

Array.<BasePropertyJSON>

# listProperties

Properties which should be visible on the list

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 50

string

# name

Resource name

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 17

object | null
Resource parent - visible on the sidebar
Properties:
Name Type Description
name string | null

Parent name
icon string

Parent icon
show boolean

Visibility

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 27

Record.<string, BasePropertyJSON>

# 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 adminjs/src/frontend/interfaces/resource-json.interface.ts, line 70

Array.<ActionJSON>

# resourceActions

Actions available for entire resource with type: resource

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 40

Array.<BasePropertyJSON>

# showProperties

Properties which should be visible on the show view

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 60

BasePropertyJSON

# titleProperty

Property which should be treated as a Main property

View Source adminjs/src/frontend/interfaces/resource-json.interface.ts, line 35