Version: 3.xx.xxSource Code

useSimpleList

By using useSimpleList, you can get properties that are compatible with Ant Design <List> component. All features such as sorting, filtering, and pagination come out of the box. Under the hood it uses useTable for the fetch.

For all the other features, you can refer to the Ant Design <List> documentation.

Basic Usage

In the following example, we will show how to use useSimpleList to list the products.

It returns listProps which is compatible with Ant Design <List> component. By default, it reads resource from the current URL.

http://localhost:3000

Live previews only work with the latest documentation.

import { Typography, AntdList, useSimpleList } from '@pankod/refine-antd'

const { Text } = Typography

interface IProduct {
  id: number
  name: string
  description: string
  price: string
}

const ProductList: React.FC = () => {
  const { listProps } = useSimpleList<IProduct>()

  return <AntdList {...listProps} renderItem={renderItem} />
}

const renderItem = (item: IProduct) => {
  const { id, name, description, price } = item

  return (
    <AntdList.Item actions={[<Text key={id}>{price}</Text>]}>
      <AntdList.Item.Meta title={name} description={description} />
    </AntdList.Item>
  )
}

Pagination

This feature comes out of the box with the listProps.pagination. It generates the pagination links for the <List> component instead of react state and overrides <List>'s pagination.itemRender value.

It also syncs the pagination state with the URL if you enable the syncWithLocation.

If you want to make a change in the pagination of the <List>. You should pass the pagination object of the listProps to the pagination property of the <List> as below. You can override the values of the pagination object as your need.

// ...
const { listProps } = useSimpleList<IProduct>()

// ...

return (
  <AntdList
    {...listProps}
    renderItem={renderItem}
    pagination={{
      ...listProps.pagination,
      position: 'top',
      size: 'small',
    }}
  />
)

info

To disable pagination, you can set hasPagination property to false which is true by default. If hasPagination has been set to false, pagination elements will be hidden in the <List> and you can handle the pagination on the client-side by overriding the pagination property in listProps.

Sorting

The useSimpleList hook supports the sorting feature. You can pass the initialSorter property to the hook to set the initial sorting state.

It also syncs the sorting state with the URL if you enable the syncWithLocation.

http://localhost:3000

Live previews only work with the latest documentation.

import { Typography, AntdList, useSimpleList } from '@pankod/refine-antd'

const { Text } = Typography

interface IProduct {
  id: number
  name: string
  description: string
  price: string
}

const ProductList: React.FC = () => {
  const { listProps } = useSimpleList<IProduct>({
    initialSorter: [
      {
        field: 'name',
        order: 'desc',
      },
    ],
  })

  return <AntdList {...listProps} renderItem={renderItem} />
}

const renderItem = (item: IProduct) => {
  const { id, name, description, price } = item

  return (
    <AntdList.Item actions={[<Text key={id}>{price}</Text>]}>
      <AntdList.Item.Meta title={name} description={description} />
    </AntdList.Item>
  )
}

Filtering

The useSimpleList hook supports the filtering feature. You can pass the initialFilter property to the hook to set the initial filtering state and you change the filtering state by using the setFilter function.

It also syncs the filtering state with the URL if you enable the syncWithLocation.

http://localhost:3000

Live previews only work with the latest documentation.

import { Typography, AntdList, useSimpleList, Input } from '@pankod/refine-antd'

const { Text } = Typography

interface IProduct {
  id: number
  name: string
  description: string
  price: string
}

const ProductList: React.FC = () => {
  const { listProps, setFilters } = useSimpleList<IProduct>({
    initialFilter: [
      {
        field: 'name',
        operator: 'contains',
        value: 'Awesome',
      },
    ],
  })

  return (
    <div>
      <Input.Search
        placeholder="Search by name"
        onChange={(e) => {
          setFilters([
            {
              field: 'name',
              operator: 'contains',
              value: e.target.value,
            },
          ])
        }}
      />
      <AntdList {...listProps} renderItem={renderItem} />
    </div>
  )
}

const renderItem = (item: IProduct) => {
  const { id, name, description, price } = item

  return (
    <AntdList.Item actions={[<Text key={id}>{price}</Text>]}>
      <AntdList.Item.Meta title={name} description={description} />
    </AntdList.Item>
  )
}

Search

We can use onSearch property and searchFormProps return value to make a custom filter form. onSearch is a function that is called when the form is submitted. searchFormProps is a property that is passed to the <Form> component.

http://localhost:3000

Live previews only work with the latest documentation.

import {
  Typography,
  AntdList,
  useSimpleList,
  Form,
  Input,
  Button,
} from '@pankod/refine-antd'
import { HttpError } from '@pankod/refine-core'

const { Text } = Typography

interface IProduct {
  id: number
  name: string
  description: string
  price: string
}

interface ISearch {
  name: string
  description: string
}

const ProductList: React.FC = () => {
  const { listProps, searchFormProps } = useSimpleList<
    IProduct,
    HttpError,
    ISearch
  >({
    onSearch: (values) => {
      return [
        {
          field: 'name',
          operator: 'contains',
          value: values.name,
        },
        {
          field: 'description',
          operator: 'contains',
          value: values.description,
        },
      ]
    },
  })

  return (
    <div>
      <Form {...searchFormProps} layout="inline">
        <Form.Item name="name">
          <Input placeholder="Search by name" />
        </Form.Item>
        <Form.Item name="description">
          <Input placeholder="Search by description" />
        </Form.Item>
        <Button type="primary" onClick={searchFormProps.form?.submit}>
          Search
        </Button>
      </Form>
      <AntdList {...listProps} renderItem={renderItem} />
    </div>
  )
}

const renderItem = (item: IProduct) => {
  const { id, name, description, price } = item

  return (
    <AntdList.Item actions={[<Text key={id}>{price}</Text>]}>
      <AntdList.Item.Meta title={name} description={description} />
    </AntdList.Item>
  )
}

Realtime Updates

This feature is only available if you use a Live Provider.

When the useSimpleList hook is mounted, it will call the subscribe method from the liveProvider with some parameters such as channel, resource etc. It is useful when you want to subscribe to live updates.

Refer to the liveProvider documentation for more information &#8594

Properties

`resource`

The useSimpleList passes the resource to the dataProvider as a param. This parameter is usually used as an API endpoint path. It all depends on how to handle the resources in your dataProvider. See the creating a data provider section for an example of how resources are handled.

The resource value is inferred from the current route where the component or the hook is used. It can be overridden by passing the resource prop.

The use case for overriding the resource prop:

We can list a category from the <ProductList> page.

import React from 'react'
import { HttpError } from '@pankod/refine-core'
import { useSimpleList } from '@pankod/refine-antd'

interface IProduct {
  id: number
  name: string
  description: string
  price: string
}

interface ICategory {
  id: number
  name: string
}

export const ProductList: React.FC = () => {
  const { tableQueryResult: productsQueryResult } = useSimpleList<
    IProduct,
    HttpError
  >()

  const { tableQueryResult: categoriesQueryResult } = useSimpleList<
    ICategory,
    HttpError
  >({
    resource: 'categories',
  })

  return <div>{/* ... */}</div>
}

Also, you can give a URL path to the resource prop.

useSimpleList({
  resource: 'categories/subcategory', // <BASE_URL_FROM_DATA_PROVIDER>/categories/subcategory
})

`initialCurrent`

Default: 1

Sets the initial value of the page index.

useSimpleList({
  initialCurrent: 2, // This will cause the list to initially display the data for page 2, rather than the default of page 1
})

`initialPageSize`

Default: 10

Sets the initial value of the page size. By default, the page size is 10.

useSimpleList({
  initialPageSize: 20, // This will cause the list to initially display 20 rows per page, rather than the default of 10
})

`initialSorter`

Sets the initial value of the sorter. The initialSorter is not permanent. It will be cleared when the user changes the sorter. If you want to set a permanent value, use the permanentSorter prop.

Refer to the CrudSorting interface for more information &#8594

useSimpleList({
  initialSorter: [
    {
      field: 'name',
      order: 'asc',
    },
  ],
})

`permanentSorter`

Sets the permanent value of the sorter. The permanentSorter is permanent and unchangeable. It will not be cleared when the user changes the sorter. If you want to set a temporary value, use the initialSorter prop.

Refer to the CrudSorting interface for more information &#8594

useSimpleList({
  permanentSorter: [
    {
      field: 'name',
      order: 'asc',
    },
  ],
})

`initialFilter`

Sets the initial value of the filter. The initialFilter is not permanent. It will be cleared when the user changes the filter. If you want to set a permanent value, use the permanentFilter prop.

Refer to the CrudFilters interface for more information &#8594

useSimpleList({
  initialFilter: [
    {
      field: 'name',
      operator: 'contains',
      value: 'Foo',
    },
  ],
})

`permanentFilter`

Sets the permanent value of the filter. The permanentFilter is permanent and unchangeable. It will not be cleared when the user changes the filter. If you want to set a temporary value, use the initialFilter prop.

Refer to the CrudFilters interface for more information &#8594

useSimpleList({
  permanentFilter: [
    {
      field: 'name',
      operator: 'contains',
      value: 'Foo',
    },
  ],
})

`defaultSetFilterBehavior`

Default: merge

The filter behavior can be set to either "merge" or "replace".

When the filter behavior is set to "merge", it will merge the new filter with the existing filters. This means that if the new filter has the same column as an existing filter, the new filter will replace the existing filter for that column. If the new filter has a different column than the existing filters, it will be added to the existing filters.
When the filter behavior is set to "replace", it will replace all existing filters with the new filter. This means that any existing filters will be removed and only the new filter will be applied to the table.

You can also override the default value by using the second parameter of the setFilters function.

useSimpleList({
  defaultSetFilterBehavior: 'replace',
})

`hasPagination`

Default: false

Determines whether to use server-side pagination or not.

useSimpleList({
  hasPagination: false,
})

`syncWithLocation`

Default: false

When you use the syncWithLocation feature, the useSimpleList's state (e.g. sort order, filters, pagination) is automatically encoded in the query parameters of the URL, and when the URL changes, the useSimpleList state is automatically updated to match. This makes it easy to share list states across different routes or pages and allows users to bookmark or share links to specific table views.

Also, you can set this value globally on the <Refine> component.

useSimpleList({
  syncWithLocation: true,
})

`queryOptions`

useSimpleList uses useTable hook to fetch data. You can pass queryOptions.

useSimpleList({
  queryOptions: {
    retry: 3,
  },
})

`metaData`

metaData is used following two purposes:

To pass additional information to data provider methods.
Generate GraphQL queries using plain JavaScript Objects (JSON). Please refer GraphQL for more information.

In the following example, we pass the headers property in the metaData object to the create method. With similar logic, you can pass any properties to specifically handle the data provider methods.

useSimpleList({
  metaData: {
    headers: { 'x-meta-data': 'true' },
  },
})

const myDataProvider = {
  //...
  getList: async ({
    resource,
    pagination,
    hasPagination,
    sort,
    filters,
    metaData,
  }) => {
    const headers = metaData?.headers ?? {}
    const url = `${apiUrl}/${resource}`

    //...
    //...

    const { data, headers } = await httpClient.get(`${url}`, { headers })

    return {
      data,
    }
  },
  //...
}

`dataProviderName`

If there is more than one dataProvider, you can specify which one to use by passing the dataProviderName prop. It is useful when you have a different data provider for different resources.

useSimpleList({
  dataProviderName: 'second-data-provider',
})

`successNotification`

NotificationProvider is required for this prop to work.

After data is fetched successfully, useSimpleList can call the open function from NotificationProvider to show a success notification. With this prop, you can customize the success notification.

useSimpleList({
  successNotification: (data, values, resource) => {
    return {
      message: `${data.title} Successfully fetched.`,
      description: 'Success with no errors',
      type: 'success',
    }
  },
})

`errorNotification`

NotificationProvider is required for this prop to work.

After data fetching is failed, useSimpleList will call the open function from NotificationProvider to show an error notification. With this prop, you can customize the error notification.

useSimpleList({
  errorNotification: (data, values, resource) => {
    return {
      message: `Something went wrong when getting ${data.id}`,
      description: 'Error',
      type: 'error',
    }
  },
})

`liveMode`

LiveProvider is required for this prop to work.

Determines whether to update data automatically ("auto") or not ("manual") if a related live event is received. It can be used to update and show data in Realtime throughout your app. For more information about live mode, please check the Live / Realtime page.

useSimpleList({
  liveMode: 'auto',
})

`onLiveEvent`

LiveProvider is required for this prop to work.

The callback function is executed when new events from a subscription have arrived.

useSimpleList({
  onLiveEvent: (event) => {
    console.log(event)
  },
})

`liveParams`

LiveProvider is required for this prop to work.

Params to pass to liveProvider's subscribe method.

`onSearch`

When searchFormProps.onFinish is called, the onSearch function is called with the values of the form. The onSearch function should return CrudFilters | Promise<CrudFilters>. When the onSearch function is called, the current page will be set to 1.

It's useful when you want to filter the data with multiple fields by using the <Form> component.

// ...

const { searchFormProps, listProps } = useSimpleList({
  onSearch: (values) => {
    return [
      {
        field: 'name',
        operator: 'contains',
        value: values.name,
      },
      {
        field: 'description',
        operator: 'contains',
        value: values.description,
      },
    ]
  },
})

// ...

return (
  <div>
    <Form {...searchFormProps} layout="inline">
      <Form.Item name="name">
        <Input placeholder="Search by name" />
      </Form.Item>
      <Form.Item name="description">
        <Input placeholder="Search by description" />
      </Form.Item>
      <Button type="primary" onClick={searchFormProps.form?.submit}>
        Search
      </Button>
    </Form>
    <AntdList {...listProps} renderItem={renderItem} />
  </div>
)

Return Values

`queryResult`

Returned values from useList hook.

`searchFormProps`

It returns <Form> instance of Ant Design. When searchFormProps.onFinish is called, it will trigger onSearch function. You can also use searchFormProps.form.submit to submit the form manually.

It's useful when you want to create a filter form for your <List>.

// ...

const { searchFormProps, listProps } = useSimpleList({
  onSearch: (values) => {
    return [
      {
        field: 'name',
        operator: 'contains',
        value: values.name,
      },
      {
        field: 'description',
        operator: 'contains',
        value: values.description,
      },
    ]
  },
})

// ...

return (
  <div>
    <Form {...searchFormProps} layout="inline">
      <Form.Item name="name">
        <Input placeholder="Search by name" />
      </Form.Item>
      <Form.Item name="description">
        <Input placeholder="Search by description" />
      </Form.Item>
      <Button type="primary" onClick={searchFormProps.form?.submit}>
        Search
      </Button>
    </Form>
    <AntdList {...listProps} renderItem={renderItem} />
  </div>
)

`listProps`

listProps is an object that contains compatible props for Ant Design [<List>][antd list] component.

`dataSource`

Contains the data to be displayed in the list. Values fetched with useList hook.

`loading`

Indicates whether the data is being fetched.

`pagination`

Returns pagination configuration values(pageSize, current, position, etc.).

`filters`

Current filters state.

`setFilters`

((filters: CrudFilters, behavior?: SetFilterBehavior) => void) & ((setter: (prevFilters: CrudFilters) => CrudFilters) => void)

A function to set current filters state.

API

Properties

Type Parameters

Property	Desription	Type	Default
TData	Result data of the mutation. Extends `BaseRecord`	`BaseRecord`	`BaseRecord`
TError	Custom error object that extends `HttpError`	`HttpError`	`HttpError`
TSearchVariables	Antd form values	`{}`	`{}`

Return values

Property	Description	Type
queryResult	Result of the query of a record	`QueryObserverResult<{ data: TData }>`
searchFormProps	Ant design Form props	`Form`
listProps	Ant design List props	`List`
filters	Current filters state	`CrudFilters`
setFilters	A function that accepts a new filter state	- `(filters: CrudFilters, behavior?: "merge" \| "replace" = "merge") => void` - `(setter: (previousFilters: CrudFilters) => CrudFilters) => void`

Basic Usage​

Pagination​

Sorting​

Filtering​

Search​

Realtime Updates​

Properties​

resource​

initialCurrent​

initialPageSize​

initialSorter​

permanentSorter​

initialFilter​

permanentFilter​

defaultSetFilterBehavior​

hasPagination​

syncWithLocation​

queryOptions​

metaData​

dataProviderName​

successNotification​

errorNotification​

liveMode​

onLiveEvent​

liveParams​

onSearch​

Return Values​

queryResult​

searchFormProps​

listProps​

dataSource​

loading​

pagination​

filters​

setFilters​

API​

Properties​

Type Parameters​

Return values​

Basic Usage

Pagination

Sorting

Filtering

Search

Realtime Updates

Properties

`resource`

`initialCurrent`

`initialPageSize`

`initialSorter`

`permanentSorter`

`initialFilter`

`permanentFilter`

`defaultSetFilterBehavior`

`hasPagination`

`syncWithLocation`

`queryOptions`

`metaData`

`dataProviderName`

`successNotification`

`errorNotification`

`liveMode`

`onLiveEvent`

`liveParams`

`onSearch`

Return Values

`queryResult`

`searchFormProps`

`listProps`

`dataSource`

`loading`

`pagination`

`filters`

`setFilters`

API

Properties

Type Parameters

Return values