Rename and refactor ListIterator

[erwanMarmelab]

Problem

ListIterator has a drawback: empty, loading and error states appear inside the wrapper (often a <ul>). It makes it unusable in most cases.

TODO

• Update new headless docs.

Solution

• remove the component
• update <SingleFieldList> and <SimpleList> to not use it
• Update WithListContext to accept optional empty, loading and error components
• Add a ListIterator alias for WithListcontext

Additional Checks

• The PR targets master for a bugfix or a documentation fix, or next for a feature
• [ ] The PR includes unit tests (if not possible, describe why)
• The PR includes one or several stories (if not possible, describe why)
• The documentation is up to date

[Madeorsk]

Does SimpleList still works when you pass data manually? It doesn't seem to be used and tested anymore.

Also, this is missing:

• Update WithListContext to accept optional empty, loading and error components

[Madeorsk]

A few issues related to WithListContext.

[Madeorsk]

Nearly done!

[fzaninotto]

This code isn't better than the previous one. It underlines the fact that RecordsIterator should probably return null while loading, without any warning.

[Madeorsk]

As ListBase doesn't provide something to hide the content while data is loading (there is a loading prop, but it only handles pending authentication), here is the current API to perfectly reproduce the previous behavior of ListIterator.

export const PostList = () => (
    <ListBase>
        <WithListContext loading={null} errorElement={null} offline={null} empty={null}>
            <RecordsIterator>
                <ReferenceArrayFieldBase reference="tags" source="tag_ids">
                    <TagList />
                </ReferenceArrayFieldBase>
            </RecordsIterator>
        </WithListContext>
    </ListBase>
);

wdyt?

[fzaninotto]

loading=null is a valid ReactNode and should be taken into account. I thing you should change the test to be as in https://github.com/marmelab/react-admin/pull/10864/files#diff-cdac9daf5ac7f12fe651a4357b777c27564f7372b0387256dd630f0a9d07c479

[fzaninotto]

should be empty ?? null IMO

[fzaninotto]

I don't know why you need data here

[Madeorsk]

This component may be called out of a list context (with data passed manually in props), so RecordsIterator may need to get data explicitly as it won't be able to get them from the list context. I add a comment to state it explicitly.

[djhi]

Shouldn't you pass it to WithListContext instead?

[Madeorsk]

It is passed to WithListContext through ...props, which then pass it down to the render function. But we need to keep it here as there's still no ListContext under WithListContext.

[fzaninotto]

same

[djhi]

Shouldn't we use <ListBase emptyWhileLoading> instead of the WithListContext?

[djhi]

Shouldn't you pass it to WithListContext instead?