Skip to content

OperationEntityPicker

OperationEntityPicker is a dialog for picking one or more rows from a clicky surface’s list operation, optionally scoped by locked parameter values. It is OperationCatalog in picker mode (a checkbox per row, row click toggles) plus a Cancel / Select footer.

Source

import { OperationEntityPicker } from "@flanksource/clicky-ui/rpc";
Single Scoped · Open in Storybook
Multi · Open in Storybook

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
cellRenderers ClickyCellRenderers — —
client* OperationsApiClient — —
filterPre FilterExtension[] — —
hiddenColumns string[] — —
initialValues Record<string, string> {} Editable starting values for the dialog's filters.
lockedLabels Record<string, string> — Display names for locked parameter keys, overriding the filter labels.
lockedValues Record<string, string> {} Pinned list parameters, shown only as the read-only "Scoped to" line.
mode enum single Defaults to "single": checking a row replaces the previous one.
note ReactNode — Extra content under the table.
onClose* (…) => void — —
onSelect* (…) => void | Promise<void> — Called by Select with the checked ids and, in the same order, the row of each id the reader checked while the dialog was open — an id carried in through `selected` and left untouched has no row. `context.filters` is the list scope at the last selection change (the opening scope when the reader never changed it). The dialog closes when this returns or resolves; a rejection is shown in the dialog, which stays open.
open* boolean — —
selected string[] [] Ids checked each time the dialog opens.
selectLabel (…) => string ({ pending }: { pending: boolean }) => pending ? "Selecting…" : "Select" Label of the confirm button; defaults to "Select" / "Selecting…".
surfaceKey* string — The clicky surface whose list operation supplies the rows.
title* string — —
unavailableRows OperationCatalogUnavailableRows — —