Skip to content

SessionsCatalog

API reference and demos for SessionsCatalog.

Source

import { SessionsCatalog } from "@flanksource/clicky-ui/rpc";

No dedicated Storybook demo is available for this component yet.

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
client* OperationsApiClient — —
getRowDetailHref (…) => string — Route of a session's page, given the row's id.
hiddenColumns string[] — —
initialValues Record<string, string> — Editable starting filters, applied only where the URL is silent. Keys are checked against the list operation's parameters like `lockedValues`.
lockedValues Record<string, string> — Filters the host pins, e.g. `{ profile: "trace-capture/jvm_trace", "label.target": "cycle" }` for one target's JVM traces. Sent on every list, lookup and export request; never editable, never in the URL. Every key must be a parameter the list operation declares: once the spec has loaded, an undeclared key renders an error in place of the table.
renderLink* RenderLink — —
surfaceKey string sessions Surface the list operation is tagged with. Defaults to SESSIONS_SURFACE_KEY.
title string Sessions Heading used in loading and export labels. Defaults to "Sessions".
urlState false | { prefix: string; } — —