Interface

ResourceOptions

ResourceOptions

Options for given resource

Usage with TypeScript

import { ResourceOptions } from 'admin-bro'

View Source admin-bro/src/backend/decorators/resource-options.interface.ts, line 6

Members

object | object

# actions Optional

List of all actions along with their options

Properties:
Name Type Attributes Description
show Partial.<Action.<RecordActionResponse>> <optional>
edit Partial.<Action.<RecordActionResponse>> <optional>
delete Partial.<Action.<RecordActionResponse>> <optional>
new Partial.<Action.<RecordActionResponse>> <optional>
list Partial.<Action.<ListActionResponse>> <optional>
{...} Partial.<Action.<ActionResponse>>

View Source admin-bro/src/backend/decorators/resource-options.interface.ts, line 69

Array.<string>

# editProperties Optional

List of properties which should be visible on edit view

View Source admin-bro/src/backend/decorators/resource-options.interface.ts, line 34

Array.<string>

# filterProperties Optional

List of properties which should be visible on the filter

View Source admin-bro/src/backend/decorators/resource-options.interface.ts, line 40

Array.<string>

# listProperties Optional

List of properties which should be visible on a list

View Source admin-bro/src/backend/decorators/resource-options.interface.ts, line 22

string

# name Optional

Name of a resource

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

object | string

# parent Optional

Parent element under which resource should be nested in sidebar. Default to the database name.

Properties:
Name Type Attributes Description
name string <optional>
icon string <optional>

View Source admin-bro/src/backend/decorators/resource-options.interface.ts, line 46

Record.<string, PropertyOptions>

# properties Optional

List of properties along with their options

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

Array.<string>

# showProperties Optional

List of properties which should be visible on show view

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

object

# sort Optional

Default sort property and direction.

Properties:
Name Type Description
direction 'asc' | 'desc'
sortBy string

View Source admin-bro/src/backend/decorators/resource-options.interface.ts, line 55