File size: 1,270 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# MediaListData
MediaListData is a React component intended to be used as a controller-view to simplify binding and interacting with the [media stores and actions](../../../lib/media/).
## Usage
Wrap a child component with `<MediaListData />`, passing a `siteId` and optional `filter`, `postId` and `search` values. [As a controller-view](https://facebook.github.io/flux/docs/overview.html#views-and-controller-views), MediaListData does not render any content of its own; instead, it simply renders the child component.
```jsx
import MediaListData from 'calypso/components/data/media-list-data';
import MyChildComponent from './my-child-component';
export default class extends React.Component {
static displayName = 'MyComponent';
render() {
return (
<MediaListData siteId={ this.props.siteId }>
<MyChildComponent />
</MediaListData>
);
}
}
```
The child component should expect to receive any props defined during the render, as well as the following additional props:
- `media`: An ordered array of known media items for the site, or `undefined` if currently fetching data
- `mediaHasNextPage`: A boolean indicating whether more media items exist for the site
- `mediaOnFetchNextPage`: A function to invoke when more media items are desired
|