Marigold
Marigold

Application

MarigoldProvider
RouterProvider

Layout

Aside
Aspect
Breakout
Center
Columns
Container
Grid
Inline
Inset
Scrollable
Split
Stack
Tiles

Actions

ActionBaralpha
Button
Link
LinkButton
ToggleButtonalpha
ToggleButtonGroupalpha

Form

Autocomplete
Calendar
Checkbox
ComboBox
DateField
DatePicker
FileField
Form
Multiselectdeprecated
NumberField
Radio
SearchField
Select
Slider
Switch
TagFieldbeta
TextArea
TextField
TimeField

Collection

SelectList
Tableupdated
Tag

Navigation

Accordion
Breadcrumbs
Pagination
Sidebarbeta
Tabs
TopNavigationbeta

Overlay

ContextualHelp
Dialog
Drawer
Menu
Toastbeta
Tooltip

Content

Badge
Card
Divider
EmptyStatebeta
Headline
Icon
List
Loader
SectionMessage
SVG
Text

Formatters

DateFormat
NumericFormat

Hooks and Utils

cn
cva
extendTheme
parseFormData
useAsyncListData
useListData
useResponsiveValue
useTheme
VisuallyHidden
Components

useAsyncListData

Hook that returns async data

We use the useAsyncListData hook from react-spectrum stately package. It extends the useListData which is also from react-spectrum.

It supports async loading, pagination, sorting and filtering. It also manages loading and error states, supports abortable requests and works with any data fetching library or the built-in browser fetch API.

More information can be found in the react-spectrum documentation.

Import

import { useAsyncListData } from '@marigold/components';

Examples

Async Table

This is an example from the <Table> component. The data will be loaded asynchronously.

Name
Height
Mass
Birth Year
import { Table, useAsyncList } from '@marigold/components';export interface asyncData {  name: string;  height: string;  mass: string;  birth_year: string;}export default () => {  let list = useAsyncList<asyncData>({    async load({ signal }) {      let res = await fetch(`https://swapi.py4e.com/api/people/?search`, {        signal,      });      let json = await res.json();      return {        items: json.results,      };    },    async sort({ items, sortDescriptor }) {      return {        items: items.sort((a, b) => {          let first = a[sortDescriptor.column as keyof asyncData];          let second = b[sortDescriptor.column as keyof asyncData];          let cmp =            (parseInt(first) || first) < (parseInt(second) || second) ? -1 : 1;          if (sortDescriptor.direction === 'descending') {            cmp *= -1;          }          return cmp;        }),      };    },  });  return (    <Table      aria-label="Example table with client side sorting"      sortDescriptor={list.sortDescriptor}      onSortChange={list.sort}    >      <Table.Header>        <Table.Column id="name" allowsSorting rowHeader>          Name        </Table.Column>        <Table.Column id="height" allowsSorting>          Height        </Table.Column>        <Table.Column id="mass" allowsSorting>          Mass        </Table.Column>        <Table.Column id="birth_year" allowsSorting>          Birth Year        </Table.Column>      </Table.Header>      <Table.Body items={list.items}>        {item => (          <Table.Row key={item.name} id={item.name}>            <Table.Cell>{item.name}</Table.Cell>            <Table.Cell>{item.height}</Table.Cell>            <Table.Cell>{item.mass}</Table.Cell>            <Table.Cell>{item.birth_year}</Table.Cell>          </Table.Row>        )}      </Table.Body>    </Table>  );};
Last update: 3 days ago

parseFormData

Parse form data into objects

useListData

Manages state for an immutable list data structure, and provides convenience methods to update the data over time.

On this page

ImportExamplesAsync Table