JSDoc: ViewHelpers

Constructor

# new ViewHelpers()

View Source admin-bro/src/backend/utils/view-helpers.ts, line 15

Methods

# bulkActionUrl(options) → {string}

Returns bulkAction url

Parameters:

Name	Type	Attributes
`options`	BulkActionParams
`resourceId`	string
`recordIds`	string	<optional>
`actionName`	string

View Source admin-bro/src/backend/utils/view-helpers.ts, line 105

Returns:

Type: string

# dashboardUrl() → {string}

Returns URL for the dashboard

View Source admin-bro/src/backend/utils/view-helpers.ts, line 58

Returns:

Type: string

# loginUrl() → {string}

Returns login URL

View Source admin-bro/src/backend/utils/view-helpers.ts, line 37

Returns:

Type: string

# logoutUrl() → {string}

Returns logout URL

View Source admin-bro/src/backend/utils/view-helpers.ts, line 44

Returns:

Type: string

# pageUrl(pageName) → {string}

Returns URL for given page name

Parameters:

Name	Type	Description
`pageName`	string	page name which is a unique key specified in AdminBroOptions

View Source admin-bro/src/backend/utils/view-helpers.ts, line 67

Returns:

Type: string

# recordActionUrl(options) → {string}

Returns recordAction url

Parameters:

Name	Type	Description
`options`	RecordActionParams
`resourceId`	string
`recordId`	string
`actionName`	string

View Source admin-bro/src/backend/utils/view-helpers.ts, line 92

Returns:

Type: string

# resourceActionUrl(options) → {string}

Returns resourceAction url

Parameters:

Name	Type	Description
`options`	ResourceActionParams
`resourceId`	string
`actionName`	string

View Source admin-bro/src/backend/utils/view-helpers.ts, line 79

Returns:

Type: string

Type Definitions

Type: object

# BulkActionParams

Params for a bulk action

Properties:

Name	Type	Attributes
`resourceId`	string
`actionName`	string
`recordIds`	Array.<string>	<optional>

View Source admin-bro/src/backend/utils/view-helpers.ts, line 142

Type: object

# RecordActionParams

Params for a record action

Properties:

Name	Type	Description
`resourceId`	string
`actionName`	string
`recordId`	string

View Source admin-bro/src/backend/utils/view-helpers.ts, line 133

Type: object

# ResourceActionParams

Params for a resource action

Properties:

Name	Type	Description
`resourceId`	string
`actionName`	string

View Source admin-bro/src/backend/utils/view-helpers.ts, line 151