Class

ResourceDecorator

ResourceDecorator(options)

Base decorator class which decorates the Resource.

Constructor

# 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>

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 28

Members

Object.<String, ActionDecorator>

# actions

Actions for a resource

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

ResourceOptions

# options

Options passed along with a given resource

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 37

Array.<PropertyDecorator>

# properties

List of all decorated properties

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

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

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 210

Actions assigned to resources

Array.<ActionDecorator>

# decorateActions() → {Record.<string, ActionDecorator>}

Used to create an ActionDecorator based on both default actions and actions specified by the user via AdminBroOptions

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 57

Record.<string, ActionDecorator>

# private decorateProperties() → {Object.<string, PropertyDecorator>}

Initializes PropertyDecorator for all properties within a resource. When user passes new property in the options - it will be created as well.

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 90

Object.<string, PropertyDecorator>

# getParent() → {Parent}

Returns resource parent along with the icon. By default it is a database type with its icon

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 137

ResourceJSON['parent']}

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

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 172

Array.<PropertyDecorator>

# getPropertyByKey(propertyPath) → {PropertyDecorator}

Returns propertyDecorator by giving property path

Parameters:
Name Type Description
propertyPath String

property path

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 155

when there is no property for given key

# getResourceName() → {string}

Returns the name for the resource.

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 122

resource name

string

# id() → {string}

Returns the id for the resource.

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 129

resource id

string

# 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

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 223

Actions assigned to each record

Array.<ActionDecorator>

# 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

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 197

Actions assigned to resources

Array.<ActionDecorator>

# 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

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 249

title of given record

String

# titleProperty() → {PropertyDecorator}

Returns PropertyDecorator of a property which should be treated as a title property.

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 234

PropertyDecorator of title property

# toJSON(currentAdmin) → {ResourceJSON}

Returns JSON representation of a resource

Parameters:
Name Type Description
currentAdmin CurrentAdmin

View Source admin-bro/src/backend/decorators/resource-decorator.ts, line 275

ResourceJSON