Skip to content
Shamar

Page actions

Pages use the same ActionBuilder API as resources, but handlers return a page-specific result (including redirects).

import { Page, ActionBuilder } from '@shamar/core'
export default class ReportsPage extends Page {
static slug = 'reports'
static label = 'Reports'
static headerActions(actions: ActionBuilder) {
actions.header('refresh', 'Refresh').icon('arrow-up')
return actions
}
static async handleAction(name: string, ctx: PageRequestContext) {
if (name === 'refresh') {
return { message: 'Refreshed', redirectTo: '/reports' }
}
return null
}
}
interface PageActionResult {
message?: string
redirectTo?: string // absolute or panel-relative path
}

ListPage can attach table actions via listActions() (same builder; rendered with the list chrome):

import { ListPage, ActionBuilder } from '@shamar/core'
export default class AuditLogPage extends ListPage {
static listActions(actions: ActionBuilder) {
actions.header('export', 'Export').icon('download')
return actions
}
}

Resource list toolbars still use resourceActions — prefer that for CRUD resources.

Page action API

MethodDescription
Page.headerActions(actions)Toolbar actions for the page.
Page.handleAction(name, ctx)Return { message?, redirectTo? }.
ListPage.listActions(actions)Actions for a list-style page.

See Pages for page kinds and registration.