Update headless docs to remove ListIterator references.

Author: Madeorsk

docs_headless/astro.config.mjs

@@ -110,7 +110,6 @@ export default defineConfig({
                         'filteringtutorial',
                         'listbase',
                         'infinitelistbase',
-                        'listiterator',
                         'filterliveform',
                         'withlistcontext',
                         'uselist',

docs_headless/src/content/docs/CustomRoutes.md

@@ -189,7 +189,7 @@ const App = () => (
 
 // in src/BookList.js
 import { useParams } from 'react-router-dom';
-import { ListBase, ListIterator } from 'ra-core';
+import { ListBase, RecordsIterator } from 'ra-core';
 
 const BookList = () => {
     const { authorId } = useParams();
@@ -198,7 +198,7 @@ const BookList = () => {
             <div>
                 <h1>Books</h1>
                 <ul>
-                    <ListIterator
+                    <RecordsIterator
                         render={book => (
                             <li key={book.id}>
                                 {book.title} ({book.year})
@@ -214,4 +214,4 @@ const BookList = () => {
 
 **Tip**: In the above example, the `resource="books"` prop is required in `<ListBase>` because the `ResourceContext` defaults to `authors` inside the `<Resource name="authors">`.
 
-Check [the `<Resource>` element documentation](./Resource.md#children) for more information.
+Check [the `<Resource>` element documentation](./Resource.md#children) for more information.

docs_headless/src/content/docs/FieldsForRelationships.md

@@ -134,7 +134,7 @@ const BookShow = () => (
 This is fine, but what if you need to display the author details for a list of books?
 
 ```jsx
-import { ListBase, ReferenceFieldBase, ListIterator } from 'ra-core';
+import { ListBase, ReferenceFieldBase, RecordsIterator } from 'ra-core';
 import { TextField } from './TextField';
 import { DateField } from './DateField';
 import { FunctionField } from './FunctionField';
@@ -152,7 +152,7 @@ const BookList = () => (
                     </tr>
                 </thead>
                 <tbody>
-                    <ListIterator>
+                    <RecordsIterator>
                         <tr>
                             <td><TextField source="title" /></td>
                             <td><DateField source="published_at" /></td>
@@ -167,7 +167,7 @@ const BookList = () => (
                                 </ReferenceFieldBase>
                             </td>
                         </tr>
-                    </ListIterator>
+                    </RecordsIterator>
                 </tbody>
             </table>
         </div>
@@ -197,7 +197,7 @@ This field fetches a one-to-many relationship, e.g. the books of an author, when
 Here is an example usage:
 
 ```jsx
-import { ShowBase, ReferenceManyFieldBase, ListIterator } from 'ra-core';
+import { ShowBase, ReferenceManyFieldBase, RecordsIterator } from 'ra-core';
 import { TextField } from './TextField';
 import { DateField } from './DateField';
 
@@ -209,12 +209,12 @@ const AuthorShow = () => (
             <DateField source="date_of_birth" />
             <ReferenceManyFieldBase reference="books" target="author_id">
                 <ul>
-                    <ListIterator>
+                    <RecordsIterator>
                         <li>
                             <TextField source="title" />
                             <DateField source="published_at" />
                         </li>
-                    </ListIterator>
+                    </RecordsIterator>
                 </ul>
             </ReferenceManyFieldBase>
         </div>
@@ -253,7 +253,7 @@ This field fetches a one-to-many relationship, e.g. the books of an author, when
 Here is an example usage:
 
 ```jsx
-import { ShowBase, ReferenceArrayFieldBase, ListIterator } from 'ra-core';
+import { ShowBase, ReferenceArrayFieldBase, RecordsIterator } from 'ra-core';
 import { TextField } from './TextField';
 import { DateField } from './DateField';
 
@@ -265,12 +265,12 @@ const AuthorShow = () => (
             <DateField source="date_of_birth" />
             <ReferenceArrayFieldBase reference="books" source="book_ids">
                 <ul>
-                    <ListIterator>
+                    <RecordsIterator>
                         <li>
                             <TextField source="title" />
                             <DateField source="published_at" />
                         </li>
-                    </ListIterator>
+                    </RecordsIterator>
                 </ul>
             </ReferenceArrayFieldBase>
         </div>
@@ -285,7 +285,7 @@ const AuthorShow = () => (
 You can also use it in a List page:
 
 ```jsx
-import { ListBase, ReferenceArrayFieldBase, ListIterator } from 'ra-core';
+import { ListBase, ReferenceArrayFieldBase, RecordsIterator } from 'ra-core';
 import { TextField } from './TextField';
 import { DateField } from './DateField';
 
@@ -302,24 +302,24 @@ const AuthorList = () => (
                     </tr>
                 </thead>
                 <tbody>
-                    <ListIterator>
+                    <RecordsIterator>
                         <tr>
                             <td><TextField source="first_name" /></td>
                             <td><TextField source="last_name" /></td>
                             <td><DateField source="date_of_birth" /></td>
                             <td>
                                 <ReferenceArrayFieldBase reference="books" source="book_ids">
                                     <ul>
-                                        <ListIterator>
+                                        <RecordsIterator>
                                             <li>
                                                 <TextField source="title" />
                                             </li>
-                                        </ListIterator>
+                                        </RecordsIterator>
                                     </ul>
                                 </ReferenceArrayFieldBase>
                             </td>
                         </tr>
-                    </ListIterator>
+                    </RecordsIterator>
                 </tbody>
             </table>
         </div>

docs_headless/src/content/docs/ListIterator.md

@@ -41,15 +41,17 @@ A typical `post` record therefore looks like this:
 In that case, use `<ReferenceArrayFieldBase>` to display the post tag names as a list of chips, as follows:
 
 ```jsx
-import { ListBase, ListIterator, ReferenceArrayFieldBase } from 'ra-core';
+import { ListBase, RecordsIterator, ReferenceArrayFieldBase, WithListContext } from 'ra-core';
 
 export const PostList = () => (
     <ListBase>
-        <ListIterator>
-            <ReferenceArrayFieldBase reference="tags" source="tag_ids">
-                <TagList />
-            </ReferenceArrayFieldBase>
-        </ListIterator>
+        <WithListContext loading={null} errorElement={null} offline={null} empty={null}>
+            <RecordsIterator>
+                <ReferenceArrayFieldBase reference="tags" source="tag_ids">
+                    <TagList />
+                </ReferenceArrayFieldBase>
+            </RecordsIterator>
+        </WithListContext>
     </ListBase>
 );