# new ResourceDecorator(options)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
object | ||
resource |
BaseResource | resource which is decorated |
|
admin |
AdminBro | current instance of AdminBro |
|
options |
ResourceOptions |
<optional> |
Members
# properties
Map of all root level properties. By root properties we mean property which is not nested under other mixed property.
Examples from PropertyOptions: { rootProperty: { type: mixed }, // root property
// nested property - this should go be the subProperty of rootProperty 'rootProperty.nested': { type: 'string' }
// also root property because there is no another property of type mixed 'another.property': { type: 'string' }, }
for a the reference {@see decorateProperties}
Methods
# bulkActions(currentAdmin) → {Array.<ActionDecorator>}
List of all actions which should be invoked for entire resource and not for a particular record
Parameters:
| Name | Type | Description |
|---|---|---|
currentAdmin |
CurrentAdmin | currently logged in admin user |
Actions assigned to resources
# getFlattenProperties()
Returns all the properties with corresponding subProperties in one object.
# getNavigation() → {Parent}
Returns resource parent along with the icon. By default it is a database type with its icon
ResourceJSON['parent']}
# getProperties(options) → {Array.<PropertyDecorator>}
Returns list of all properties which will be visible in given place (where)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
Object | ||
where |
String | one of: 'list', 'show', 'edit', 'filter' |
|
max |
String |
<optional> |
maximum number of properties returned where there are no overrides in the options |
# getPropertyByKey(propertyPath) → {PropertyDecorator}
Returns propertyDecorator by giving property path
Parameters:
| Name | Type | Description |
|---|---|---|
propertyPath |
String | property path |
# recordActions(currentAdminopt) → {Array.<ActionDecorator>}
List of all actions which should be invoked for given record and not for an entire resource
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
currentAdmin |
CurrentAdmin |
<optional> |
currently logged in admin user |
Actions assigned to each record
# resourceActions(currentAdmin) → {Array.<ActionDecorator>}
List of all actions which should be invoked for entire resource and not for a particular record
Parameters:
| Name | Type | Description |
|---|---|---|
currentAdmin |
CurrentAdmin | currently logged in admin user |
Actions assigned to resources
# titleOf(record) → {String}
Returns title for given record.
For example: If given record has name property and this property has isTitle flag set in
options or by the Adapter - value for this property will be shown
Parameters:
| Name | Type | Description |
|---|---|---|
record |
BaseRecord |
title of given record
# titleProperty() → {PropertyDecorator}
Returns PropertyDecorator of a property which should be treated as a title property.
PropertyDecorator of title property
# toJSON(currentAdmin) → {ResourceJSON}
Returns JSON representation of a resource
Parameters:
| Name | Type | Description |
|---|---|---|
currentAdmin |
CurrentAdmin |
