Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions UNRELEASED.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Use [the changelog guidelines](https://git.io/polaris-changelog-guidelines) to f

### Documentation

- Added all props example of `ResourceList` in the [style guide](https://polaris.shopify.com) ([#978](https://github.com/Shopify/polaris-react/pull/978))

### Development workflow

### Dependency upgrades
Expand Down
147 changes: 147 additions & 0 deletions src/components/ResourceList/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -615,6 +615,153 @@ Use persistent shortcut actions in rare cases when the action cannot be made ava
</Card>
```

### Resource list with all of its elements

Use as a broad example that includes most props available to resource list.

```jsx
class ResourceListExample extends React.Component {
state = {
selectedItems: [],
sortValue: 'DATE_MODIFIED_DESC',
searchValue: '',
appliedFilters: [
{
key: 'accountStatusFilter',
value: 'Account enabled',
},
],
};
handleSearchChange = (searchValue) => {
this.setState({searchValue});
};
handleFiltersChange = (appliedFilters) => {
this.setState({appliedFilters});
};
handleSortChange = (sortValue) => {
this.setState({sortValue});
};
handleSelectionChange = (selectedItems) => {
this.setState({selectedItems});
};
renderItem = (item) => {
const {id, url, name, location, latestOrderUrl} = item;
const media = <Avatar customer size="medium" name={name} />;
const shortcutActions = latestOrderUrl
? [{content: 'View latest order', url: latestOrderUrl}]
: null;
return (
<ResourceList.Item
id={id}
url={url}
media={media}
accessibilityLabel={`View details for ${name}`}
shortcutActions={shortcutActions}
persistActions
>
<h3>
<TextStyle variation="strong">{name}</TextStyle>
</h3>
<div>{location}</div>
</ResourceList.Item>
);
};
render() {
const resourceName = {
singular: 'customer',
plural: 'customers',
};
const items = [
{
id: 341,
url: 'customers/341',
name: 'Mae Jemison',
location: 'Decatur, USA',
latestOrderUrl: 'orders/1456',
},
{
id: 256,
url: 'customers/256',
name: 'Ellen Ochoa',
location: 'Los Angeles, USA',
latestOrderUrl: 'orders/1457',
},
];
const promotedBulkActions = [
{
content: 'Edit customers',
onAction: () => console.log('Todo: implement bulk edit'),
},
];
const bulkActions = [
{
content: 'Add tags',
onAction: () => console.log('Todo: implement bulk add tags'),
},
{
content: 'Remove tags',
onAction: () => console.log('Todo: implement bulk remove tags'),
},
{
content: 'Delete customers',
onAction: () => console.log('Todo: implement bulk delete'),
},
];
const filters = [
{
key: 'orderCountFilter',
label: 'Number of orders',
operatorText: 'is greater than',
type: FilterType.TextField,
},
{
key: 'accountStatusFilter',
label: 'Account status',
operatorText: 'is',
type: FilterType.Select,
options: ['Enabled', 'Invited', 'Not invited', 'Declined'],
},
];
const filterControl = (
<ResourceList.FilterControl
filters={filters}
appliedFilters={this.state.appliedFilters}
onFiltersChange={this.handleFiltersChange}
searchValue={this.state.searchValue}
onSearchChange={this.handleSearchChange}
additionalAction={{
content: 'Save',
onAction: () => console.log('New filter saved'),
}}
/>
);
return (
<Card>
<ResourceList
resourceName={resourceName}
items={items}
renderItem={this.renderItem}
selectedItems={this.state.selectedItems}
onSelectionChange={this.handleSelectionChange}
promotedBulkActions={promotedBulkActions}
bulkActions={bulkActions}
sortValue={this.state.sortValue}
sortOptions={[
{label: 'Newest update', value: 'DATE_MODIFIED_DESC'},
{label: 'Oldest update', value: 'DATE_MODIFIED_ASC'},
]}
onSortChange={(selected) => {
this.setState({sortValue: selected});
console.log(`Sort option changed to ${selected}.`);
}}
filterControl={filterControl}
/>
</Card>
);
}
}
```

---

## Build
Expand Down