OperationEntityPage
API reference and demos for OperationEntityPage.
Import
Section titled “Import”import { OperationEntityPage } from "@flanksource/clicky-ui/rpc";The props table documents the component-specific surface. Standard DOM attributes inherited from React, such as className, event handlers, and accessibility attributes, may also be accepted when the component’s prop type extends a native element.
| Prop | Type | Default | Description |
|---|---|---|---|
actionLabels |
Record<string, string> |
— | — |
allOperations |
boolean |
false |
— |
backHref |
string |
— | — |
backLabel |
string |
Back |
— |
client* |
OperationsApiClient |
— | — |
commandRuntime |
ClickyCommandRuntime |
— | — |
definition* |
DomainDefinition |
— | — |
detailOperationId |
string |
— | — |
entities* |
string[] |
— | — |
entityDetailBodyRenderer |
EntityDetailBodyRenderer |
— | Replaces the detail body after the entity has loaded while leaving the explorer-owned heading and entity actions in place. Hosts can use this for connection browsers and other entity-specific workspaces. |
entityDetailHeaderRenderer |
EntityDetailHeaderRenderer |
— | Replaces the explorer-owned "{title}: {id}" heading while leaving the back link, method badge, and entity actions in place. Hosts use this for compact entity summaries (e.g. a connection's name, endpoint, and server version). |
formActions |
FormActionsRenderer |
— | — |
formPost |
PostExtension[] |
— | — |
formPre |
PreExtension[] |
— | — |
id |
string |
— | — |
listOperationId |
string |
— | — |
operationIdPrefix |
string |
— | — |
renderError |
(…) => ReactNode |
— | — |
renderLink |
RenderLink |
— | — |
surfaceKey |
string |
— | — |