Skip to main content

AdminForthActionInput

Properties​

action?​

optional action?: (params) => Promise<{ error?: string; message?: string; ok: boolean; }>

Parameters​

ParameterType
params{ adminforth: IAdminForth; adminUser: AdminUser; extra?: HttpExtra; recordId: string; resource: AdminForthResource; response: IAdminForthHttpResponse; tr: ITranslateFunction; }
params.adminforthIAdminForth
params.adminUserAdminUser
params.extra?HttpExtra
params.recordIdstring
params.resourceAdminForthResource
params.responseIAdminForthHttpResponse
params.trITranslateFunction

Returns​

Promise<{ error?: string; message?: string; ok: boolean; }>

allowed?​

optional allowed?: boolean | ((params) => boolean | Promise<boolean>)

bulkConfirmationMessage?​

optional bulkConfirmationMessage?: string

bulkDangerous?​

optional bulkDangerous?: boolean

When true, the bulk confirmation dialog renders in red/danger style.

bulkHandler?​

optional bulkHandler?: (params) => Promise<{ error?: string; ok: boolean; successMessage?: string; }>

Parameters​

ParameterType
params{ adminforth: IAdminForth; adminUser: AdminUser; extra?: HttpExtra; recordIds: (string | number)[]; resource: AdminForthResource; response: IAdminForthHttpResponse; tr: ITranslateFunction; }
params.adminforthIAdminForth
params.adminUserAdminUser
params.extra?HttpExtra
params.recordIds(string | number)[]
params.resourceAdminForthResource
params.responseIAdminForthHttpResponse
params.trITranslateFunction

Returns​

Promise<{ error?: string; ok: boolean; successMessage?: string; }>

bulkSuccessMessage?​

optional bulkSuccessMessage?: string

customComponent?​

optional customComponent?: AdminForthComponentDeclaration

icon?​

optional icon?: string

id?​

optional id?: string

name​

name: string

showIn?​

optional showIn?: object

bulkButton?​

optional bulkButton?: boolean

list?​

optional list?: boolean

listThreeDotsMenu?​

optional listThreeDotsMenu?: boolean

showButton?​

optional showButton?: boolean

showThreeDotsMenu?​

optional showThreeDotsMenu?: boolean

url?​

optional url?: string | ((params) => string)