Skip to content
IzzyBlazor 0.1.0-alpha.17

Enter all results ↑ ↓ move Esc close

FilterForm

Search and filters kept in the URL.

IzzyBlazor.FilterForm in the IzzyBlazor.Core package, generated from the 0.1.0-alpha.17 assembly and its doc comments.

Properties (6)

ChildContentRenderFragment?

The filter fields: FilterSearch, FilterSelect, FilterCheckbox, or your own inputs (list their names in Fields).

Livebool = true

Applies as you type and on every change, with JavaScript. Defaults to true; false keeps the Apply button.

FieldsIReadOnlyList<string>?

The names of inputs you add yourself, so the form doesn't also carry them over from the URL.

Labelstring? = "Filters"

The search landmark's name. Defaults to "Filters".

ApplyTextstring? = "Apply"

The submit button's text, shown when JavaScript is off or Live is false. Defaults to "Apply".

ClearTextstring? = "Clear"

The text of the link that removes every filter. Defaults to "Clear".

Item props (from LayoutItemBase)

MarginResponsive<int>Responsive

Margin on all sides, in spacing steps (-16 to 16; one step = 4px).

MarginXResponsive<int>Responsive

Horizontal margin. When set, replaces Margin on this axis.

MarginYResponsive<int>Responsive

Vertical margin. When set, replaces Margin on this axis.

MarginTopResponsive<int>Responsive

Top margin. When set, replaces MarginY and Margin on this side.

MarginBottomResponsive<int>Responsive

Bottom margin. When set, replaces MarginY and Margin on this side.

MarginStartResponsive<int>Responsive

Margin at the start (left in left-to-right text, right in right-to-left). Replaces MarginX and Margin on this side.

MarginEndResponsive<int>Responsive

Margin at the end (right in left-to-right text, left in right-to-left). Replaces MarginX and Margin on this side.

WidthResponsive<Length>Responsive

Width.

MinWidthResponsive<Length>Responsive

Minimum width.

MaxWidthResponsive<Length>Responsive

Maximum width.

Growbool = false

Whether to grow into free space inside a Stack, Row or Column: <Box Grow>.

Shrinkbool = true

Whether to shrink when space is short inside a Stack, Row or Column. Defaults to true; Shrink="false" keeps the size.

BasisResponsive<Length>Responsive

Starting size inside a Stack, before growing or shrinking.

AlignSelfResponsive<Align>Responsive

Alignment across the parent's direction, overriding the parent's Align for this component only, such as a button lined up with the bottom of labeled fields in a Row.

ColSpanResponsive<int>Responsive

How many columns it spans in a Form or Fieldset with Columns, or a Grid; GridSpan.Full for the whole row. Never more than the columns shown, so a form that narrows to one column needs no breakpoints.

NewRowbool = false

Starts a new row in a Form or Fieldset with Columns, or a Grid, leaving the rest of the row before it empty.

Common props (from IzzyComponentBase)

Classstring?

Extra CSS classes, merged after the component's own classes.

Stylestring?

Inline style, appended after the component's generated custom properties.

HiddenFromBreakpoint?

Hides the component from this breakpoint up, such as a menu button only phones need.

VisibleFromBreakpoint?

Shows the component only from this breakpoint up, such as header links for wide screens.

Events (0)

No events.

Parts (3)

Components written inside FilterForm, documented here with it.

FilterSearch

A search box for a FilterForm. Its value is ?q= by default.

Placeholderstring? = "Search"

Hint text inside the box. Defaults to "Search".

Namestring = "q"

The query-string name, such as status.

Labelstring?

The field's name for screen readers (shown beside a FilterCheckbox). Filter bars are compact, so a search box's and a select's isn't shown. Required on FilterSelect and FilterCheckbox; FilterSearch's defaults to "Search".

SizeControlSize = ControlSize.Md

Control height and text size. Defaults to ControlSize.Md.

FilterSelect

A select for a FilterForm, with an "all" option first. Options come from Items or an enum (EnumType, using [Display(Name)]).

ItemsIEnumerable<string>?

The values to choose from.

EnumTypeType?

An enum whose names are the values.

ItemTextFunc<string, string>?

Display text for a value, when it differs from the value.

AllTextstring? = "{Label}: All"

The first option, meaning no filter. Defaults to "{Label}: All".

Namestring = ""

The query-string name, such as status.

Labelstring?

The field's name for screen readers (shown beside a FilterCheckbox). Filter bars are compact, so a search box's and a select's isn't shown. Required on FilterSelect and FilterCheckbox; FilterSearch's defaults to "Search".

SizeControlSize = ControlSize.Md

Control height and text size. Defaults to ControlSize.Md.

FilterCheckbox

A checkbox for a FilterForm: when checked the URL has name=true.

Namestring = ""

The query-string name, such as status.

Labelstring?

The field's name for screen readers (shown beside a FilterCheckbox). Filter bars are compact, so a search box's and a select's isn't shown. Required on FilterSelect and FilterCheckbox; FilterSearch's defaults to "Search".

SizeControlSize = ControlSize.Md

Control height and text size. Defaults to ControlSize.Md.

Types (1)

ControlSize

enum

The height of interactive controls. Shared by buttons and form fields, so a button and an input of the same size line up in a row.

ControlSize values
ValueDescription
Sm

32px tall, small text.

Md

36px tall (the default).

Lg

44px tall, large text. For touch-first and marketing pages.