Polaris-react: ResourceList does not render item as per doc

Created on 26 Jul 2017 · 5Comments · Source: Shopify/polaris-react

Issue summary

Hi,

If I follow the documentation of ResourceList (https://polaris.shopify.com/components/lists/resource-list#navigation) the code should display the list item as per the example.

Actual behavior

Instead, because of the render function being empty, nothing is rendered. If I remove the renderFunction (hoping it would default to some sane defaults), it throws an exception due to missing render item function.

Specifications

Polaris version: 1.1.1
React version: 15.6

Source

bakura10

👍7

Most helpful comment

It looks like the renderItem function needs to be updated from:

renderItem={() => {}}

renderItem={(item, index) => {
  return <ResourceList.Item key={index} {...item} />;
}}

recio862 on 30 Sep 2017

👍10

All 5 comments

EDIT : got it, the doc is not up to date with this document: https://github.com/Shopify/polaris/tree/master/src/components/ResourceList

I leave this issue open for now :).

bakura10 on 26 Jul 2017

Hey @bakura10, you’re right. Looks like an issue with the polaris site—the example code is loaded directly from that readme file, so something must be displaying wrong. We’re looking into it.

ry5n on 1 Aug 2017

It looks like the renderItem function needs to be updated from:

renderItem={() => {}}

renderItem={(item, index) => {
  return <ResourceList.Item key={index} {...item} />;
}}

recio862 on 30 Sep 2017

👍10

You’re totally right.

The content for each component page on polaris.shopify.com is parsed from the README in the codebase. The one for ResourceList is correct, so it looks like it’s not getting parsed correctly.

We’ll get this fixed. Thanks for flagging it!

ry5n on 2 Oct 2017

👍2

This is resolved in the latest resource list documentation: https://polaris.shopify.com/components/lists/resource-list