FilterForm

API reference and demos for FilterForm.

Source

Import

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

Demos

Default · Open in Storybook

Auto Submit · 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
autoSubmit	boolean	false	—
className	string	—	—
client*	OperationsApiClient	—	—
emptyMessage	string	This operation does not require input.	—
enableLookup	boolean	method.toUpperCase() === "GET"	—
excludedParameterNames	string[]	[]	—
formId	string	—	—
hideLocked	boolean	false	—
initialValues	ParameterValues	{}	—
isSubmitting	boolean	false	—
lockedValues	ParameterValues	{}	—
method*	string	—	—
onChange	(…) => …	—	Called with the current values whenever they change, starting with the initial values, so the form can act as a controlled field set inside a host form (pair with showSubmit={false}).
onSubmit*	(…) => void | Promise<void>	—	—
parameters	OpenAPIParameter[]	[]	—
path*	string	—	—
presentation	enum	form	Renders operation controls as form rows or the shared table FilterBar.
showSubmit	boolean	true	—
submitLabel	string	Execute request	—
submittingLabel	string	Executing…	—