Adonis Cockpit is currently in prerelease version. Documentation, references and examples might not be correct and are subject to change. Give your feedback.
Actions
Actions are operations that can be applied with one or multiple records.
Creating Actions
Actions are simple classes that extend Action.
label: The label displayed in theActionsMenuicon: The icon displayed in theActionsMenuhandle()The method called when running the action.
Example
import { Action } from 'adonis-cockpit/actions'
export default class SynchronizeAction extends Action {
label = 'Synchronize'
icon = 'pi pi-sync'
handle(resource: BaseResource, ids: RecordId[]) {
return customService.synchronize(resource.name, ...ids)
}
}
Confirmation Dialog
It is important to ask the user for confirmation when running important tasks. You can achieve that by adding a confirmation method to your action that returns the properties for the dialog. See the available options
import { Action } from 'adonis-cockpit/actions'
export default class SynchronizeAction extends Action {
// ...
confirmation() {
return {
header: 'Synchronize Records',
message: 'Are you sure you want to synchronize the records?'
}
}
}