Skip to content

Commit

Permalink
feat: add itemList
Browse files Browse the repository at this point in the history
  • Loading branch information
pereag committed Feb 26, 2024
1 parent e67c51f commit 8ac755e
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions docs/components/01-item-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import { GitHubLogo } from '../../src/icons/GitHubLogo';
<Description
extendsInfo={[
{
label: 'ActionRowOverflow',
link: './action-row-overflow',
label: 'CardList',
link: './card-list',
logo: <GitHubLogo />,
},
]}
Expand All @@ -29,9 +29,16 @@ import { GitHubLogo } from '../../src/icons/GitHubLogo';

## Props

ItemList takes a `<Data>` generic type that extends `Record<string, unknown>`, to be used by [ActionRowOverflow](./action-row-overflow).

| Name | Type | Default | Description |
| ----------------- | --------- | ------- | ------------------------------------------------------------------------------ |
| items <Required/> | `IItem[]` | | An array of elements of type IItem that allows you to populate the list items. |
| ... | - | - | extends [`ICardListProps`](./card-list#props) |
| items <Required/> | `IItem[]` | - | An array of elements of type IItem that allows you to populate the list items. |
| ... | - | - | Extends [`ICardListProps`](./card-list#props) |

## IItem

| Attribute | Type | Description |
| ----------------- | -------- | --------------------------------------- |
| color | `string` | Color displayed to the left of the text |
| description | `string` | Element below the title |
| details | `string` | Element element below details |
| title <required/> | `string` | Item title |

0 comments on commit 8ac755e

Please sign in to comment.