ResourceList
ResourceList displays a filterable collection of objects of the same type, like products or customers.
ResourceList should help merchants find an object and navigate to a full-page representation of it.
A resource list should contain ResourceItem components.
optional = ?
| Name | Type | Description |
|---|---|---|
| filterControl? | FilterControl |
FilterControl
Anchor link to section titled "FilterControl"| Name | Type | Description |
|---|---|---|
| queryValue? | string |
Search query value |
| queryPlaceholder? | string |
Placeholder for search query field |
| onQueryChange | (queryValue: string) => void |
Callback when search query changes |
| onQueryClear | () => void |
Callback when the search field is cleared |
A resource list should contain only ResourceItem components.
| ✅ Do | 🛑 Don't |
|---|---|
| Use ResourceList to show a summary of the resource | ResourceLists should not contain elements other than ResourceItems |
For more guidelines, refer to Polaris' Resource List best practices.