EntityExplorerApp

API reference and demos for EntityExplorerApp.

Source

Import

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

Demos

Default · Open in Storybook

Drill Down Breadcrumb · Open in Storybook

Orders · 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.

Props

Prop	Type	Default	Description
actions	ReactNode	—	Right-aligned top-bar cluster forwarded to AppShell's actions slot.
basePath	string	—	—
client*	OperationsApiClient	—	—
entityDetailBodyRenderer	EntityDetailBodyRenderer	—	Host override for a loaded entity's body; heading and actions remain.
entityDetailHeaderRenderer	EntityDetailHeaderRenderer	—	Host override for a loaded entity's "{title}: {id}" heading.
formActions	FormActionsRenderer	—	Optional extra footer actions added to every create/edit form (e.g. a connection "Test" split-button). The renderer receives the live form value and the action it submits to, so it can scope itself to a given entity.
formExtensions	{ pre?: PreExtension[]; post?: PostExtension[]; }	—	Custom JsonSchemaForm field extensions applied to every create/edit form the explorer renders — e.g. a SecretKeySelector widget keyed on an `x-clicky-component` schema hint. `pre` transforms a resolved control; `post` can replace the rendered value node with a custom component.
resultRenderer	ResultRenderer	—	Optional host override for the result surface. Called where an entity's result table renders, with the current surface key, the raw response, and the default OperationResultView element. Return `defaultView` to keep the standard table, or a custom node (e.g. a LogsTable for trace/log profiles flagged via x-clicky-render). Filtering/sorting policy is the host's choice.
showApiExplorer	boolean	true	—
surfaceActionLabels	SurfaceActionLabels	—	Per-surface labels keyed by x-clicky verb/actionName.
surfaceIcons	Record<string, ReactNode>	—	@deprecated Superseded by per-surface icons emitted by the backend (x-clicky-icon → ClickySurface.icon). AppShell section labels are plain strings, so this group-header icon map is no longer rendered. Kept for source-compatibility only.
surfacePaginationMode	(…) => "infinite" | "paged"	—	Per-surface paging presentation, forwarded to OperationCatalog's `paginationMode`. Return undefined to keep automatic selection (a cursor walk whenever the list declares a cursor); return "paged" for a surface whose readers need prev/next offset controls.
surfaceTitleActions	(…) => ReactNode	—	Compact host controls (e.g. an edit icon) shown right after a surface's title or breadcrumb in the top bar.