PowerSearch

Build structured filters with the Astryx power search field.

config describes the searchable fields and their operators, and value holds the current filter records, each {"field": ..., "operator": ..., "value": ...}. Both are plain JSON, matching how :class:Table and :class:TreeList take their data.

Notes

See Astryx component docs: https://astryx.atmeta.com/components/PowerSearch.

Functions

constructor__init__

(config, filters=(), *, label='', placeholder=None, disabled=False, read_only=None, clear=None, label_hidden=None, menu_width=None, **props) -> None

paramconfigMapping[str, Any]

Search configuration: {"name": ..., "fields": [...]}, where each field takes a key, a label, and an operators sequence.

paramfiltersIterable[Mapping[str, Any]]

= ()

Active filter records, synchronized as value.

paramlabelstr

= ''

Visible or accessible label for the component.

paramplaceholderstr | None

= None

Placeholder text shown when no filter is set.

paramdisabledbool

= False

Whether the component should render disabled.

paramread_onlybool | None

= None

Whether existing filters can be edited.

paramclearbool | None

= None

Whether to show a clear control.

paramlabel_hiddenbool | None

= None

Whether to visually hide the accessible label.

parammenu_widthint | None

= None

Fixed suggestion menu width in pixels.

parampropsAny

= {}

Returns

None

Functions

On this page