FilterForm
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 = trueApplies 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".
Plus 16 item props and 4 common props.
Show them hereEvents (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.MdControl 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.MdControl 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.MdControl height and text size. Defaults to ControlSize.Md.
Types (1)
ControlSize
enumThe 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.
| Value | Description |
|---|---|
Sm | 32px tall, small text. |
Md | 36px tall (the default). |
Lg | 44px tall, large text. For touch-first and marketing pages. |