Skip to content

Commit

Permalink
feat: starting adding itemList doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pereag committed Feb 26, 2024
1 parent f2d2240 commit e67c51f
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/components/01-item-list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import { GitHubLogo } from '../../src/icons/GitHubLogo';

# Item list

<Description
extendsInfo={[
{
label: 'ActionRowOverflow',
link: './action-row-overflow',
logo: <GitHubLogo />,
},
]}
importExample="import { ItemList } from '@smile/react-front-kit';"
packageInfo={{
label: '@smile/react-front-kit',
link: 'https://www.npmjs.com/package/@smile/react-front-kit',
}}
sourceInfo={{
link: 'https://github.com/Smile-SA/react-front-kit/blob/main/packages/react-front-kit/src/Components/ItemList/ItemList.tsx',
}}
>
Display a list of simple items with a title, a color, a details section, and a
description.
</Description>

## Storybook Docs

<StorybookEmbed storyId="3-custom-components-ItemList--docs" height="820" />

## 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) |

0 comments on commit e67c51f

Please sign in to comment.