DmSearch
DmSearch collects table filters across text, choice, date, and custom fields.
@duskmoon-dev/components/dm-searchUsage
When to use
- Use it in DuskMoon application screens that need a packaged, opinionated workflow component.
- Reach for the lower-level standard component when the screen needs custom composition.
Implementation notes
Features
Wraps lower-level primitives into a higher-level DuskMoon-prefixed workflow API.
Examples show the defaults and composition points expected by internal DuskMoon app screens.
DmSearch is most often configured through `items`, `values`, `onValuesChange`, `onReset`.
Submits values and toggles collapsed fields
Feature Demos
Feature demos are authored for the component page, then supplemented with behavior scenarios from the component test coverage.
Basic usage
Import the component stylesheet and DmSearch from its package subpath, then render it with the core props.
Source
import "@duskmoon-dev/components/styles.css";
import { DmSearch } from "@duskmoon-dev/components/dm-search";
export function Example() {
return (<DmSearch
items={[{
key: "name",
title: "Name",
dataIndex: "name",
search: { type: "input" }
}]}
onSearch={(values) => console.log(values)}
/>);
}Submits values and toggles collapsed fields
test-backedDmSearch scenario from the component test coverage: submits values and toggles collapsed fields.
Source
import "@duskmoon-dev/components/styles.css";
import { DmSearch } from "@duskmoon-dev/components/dm-search";
export function DmSearchSubmitsValuesAndTogglesDemo() {
return (<DmSearch
items={[{
key: "name",
title: "Name",
dataIndex: "name",
search: { type: "input" }
}]}
onSearch={(values) => console.log(values)}
/>);
}Honors searchParams and imperative reset
test-backedDmSearch scenario from the component test coverage: honors searchparams and imperative reset.
Source
import "@duskmoon-dev/components/styles.css";
import { DmSearch } from "@duskmoon-dev/components/dm-search";
export function DmSearchHonorsSearchParamsAndImperativeDemo() {
return (<DmSearch
items={[{
key: "name",
title: "Name",
dataIndex: "name",
search: { type: "input" }
}]}
onSearch={(values) => console.log(values)}
/>);
}Controlled records remain authoritative through edits, rerenders, collapse, and submission
test-backedDmSearch scenario from the component test coverage: controlled records remain authoritative through edits, rerenders, collapse, and submission.
Source
import "@duskmoon-dev/components/styles.css";
import { DmSearch } from "@duskmoon-dev/components/dm-search";
export function DmSearchControlledRecordsRemainAuthoritativeDemo() {
return (<DmSearch
items={[{
key: "name",
title: "Name",
dataIndex: "name",
search: { type: "input" }
}]}
onSearch={(values) => console.log(values)}
/>);
}Custom fields own labels and preserve typed values through controlled reset
test-backedDmSearch scenario from the component test coverage: custom fields own labels and preserve typed values through controlled reset.
Source
import "@duskmoon-dev/components/styles.css";
import { DmSearch } from "@duskmoon-dev/components/dm-search";
export function DmSearchCustomFieldsOwnLabelsDemo() {
return (<DmSearch
items={[{
key: "name",
title: "Name",
dataIndex: "name",
search: { type: "input" }
}]}
onSearch={(values) => console.log(values)}
/>);
}Legacy reset still searches while controlled reset without handler emits next values
test-backedDmSearch scenario from the component test coverage: legacy reset still searches while controlled reset without handler emits next values.
Source
import "@duskmoon-dev/components/styles.css";
import { DmSearch } from "@duskmoon-dev/components/dm-search";
export function DmSearchLegacyResetStillSearchesDemo() {
return (<DmSearch
items={[{
key: "name",
title: "Name",
dataIndex: "name",
search: { type: "input" }
}]}
onSearch={(values) => console.log(values)}
/>);
}Passes noValidate to the native form so custom validation owns submission
test-backedDmSearch scenario from the component test coverage: passes novalidate to the native form so custom validation owns submission.
Source
import "@duskmoon-dev/components/styles.css";
import { DmSearch } from "@duskmoon-dev/components/dm-search";
export function DmSearchPassesNoValidateToTheDemo() {
return (<DmSearch
items={[{
key: "name",
title: "Name",
dataIndex: "name",
search: { type: "input" }
}]}
onSearch={(values) => console.log(values)}
/>);
}Theme aware
Docs previews inherit the DuskMoon data-theme value. Use the header switch to compare light and dark rendering.
Source
<div data-theme="sunshine">
<DmSearch
items={[{
key: "name",
title: "Name",
dataIndex: "name",
search: { type: "input" }
}]}
onSearch={(values) => console.log(values)}
/>
</div>
<div data-theme="moonlight">
<DmSearch
items={[{
key: "name",
title: "Name",
dataIndex: "name",
search: { type: "input" }
}]}
onSearch={(values) => console.log(values)}
/>
</div>API
The API reference below lists every parsed exported type or interface for DmSearch. Start with `items`, `values`, `onValuesChange`, `onReset` for common usage.
packages/components/src/components/dm-search/DmSearch.types.tsScenarios: packages/components/src/components/dm-search/DmSearch.test.tsx| Prop | Type | Required | Description |
|---|---|---|---|
items | DmSearchItem[] | No | items configures DmSearch. |
values | Record<string, unknown> | No | values configures DmSearch. |
onValuesChange | (values: Record<string, unknown>) => void | No | onValuesChange configures DmSearch. |
onReset | (values: Record<string, unknown>) => void | No | onReset configures DmSearch. |
onSearch | (values: Record<string, unknown>) => void | No | onSearch configures DmSearch. |
extra | ReactNode | No | extra configures DmSearch. |
fastFilterItem | DmSearchItem | No | fastFilterItem configures DmSearch. |
defaultCollapsed | boolean | No | defaultCollapsed configures DmSearch. |
hideCollapseBtn | boolean | No | hideCollapseBtn configures DmSearch. |
compact | boolean | No | compact configures DmSearch. |
searchParams | Record<string, unknown> | No | searchParams configures DmSearch. |
loading | boolean | No | loading configures DmSearch. |
noValidate | boolean | No | noValidate configures DmSearch. |
enableDefaultPlaceHolder | boolean | No | enableDefaultPlaceHolder configures DmSearch. |
className | string | No | className configures DmSearch. |
inputProps | Partial<InputProps> | No | inputProps configures DmSearch. |
selectProps | Partial<SelectProps> | No | selectProps configures DmSearch. |
datePickerProps | Partial<DatePickerProps & RangePickerProps> | No | datePickerProps configures DmSearch. |
| Prop | Type | Required | Description |
|---|---|---|---|
onReset | () => void | Yes | onReset configures DmSearch. |
| Prop | Type | Required | Description |
|---|---|---|---|
key | string | Yes | key configures DmSearch. |
title | ReactNode | Yes | title configures DmSearch. |
dataIndex | string | Yes | dataIndex configures DmSearch. |
search | { | Yes | search configures DmSearch. |
type | DmSearchItemType | Yes | type configures DmSearch. |
extraProps | Record<string, unknown> | No | extraProps configures DmSearch. |
formProps | { | No | formProps configures DmSearch. |
initialValue | unknown | No | initialValue configures DmSearch. |
rules | unknown[] | No | rules configures DmSearch. |
render | ( | No | render configures DmSearch. |
value | unknown, | Yes | value configures DmSearch. |
setValue | (value: unknown) => void, | Yes | setValue configures DmSearch. |
item | DmSearchItem, | Yes | item configures DmSearch. |
Type definition
| "input" | "input-number" | "select" | "radio" | "checkbox" | "date" | "dateRange" | "custom"