Skip to content

EntitySurface

EntitySurface lists one surface wherever a host places it — the same listing, filters and result renderer EntityExplorerApp shows on the surface’s own route, embedded in another page (e.g. a connection’s logs on its detail page). Filter state lives in the current URL’s query string, as it does on the route.

Source

import { EntitySurface } 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 — —
paginationMode enum — —
resultRenderer ResultRenderer — —
surfaceKey* string — The surface to list, as the OpenAPI spec's `x-clicky.surfaces` keys it.