Skip to content

Commit

Permalink
Merge branch 'main' into feat/ItemList
Browse files Browse the repository at this point in the history
  • Loading branch information
vapersmile authored Feb 28, 2024
2 parents 6f953ec + 0513cf9 commit 0e332f7
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/components/01-card-list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import { GitHubLogo } from '../../src/icons/GitHubLogo';

# Card List

<Description
extendsInfo={[
{
label: 'ScrollArea',
link: 'https://v6.mantine.dev/core/scroll-area/',
},
]}
importExample="import { CardList } 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/CardList/CardList.tsx',
}}
>
Renders a section of card containing a list of items with the option of having
or not having a separator and a vertical scrolling bar
</Description>

## Storybook Docs

<StorybookEmbed storyId="3-custom-components-cardlist" height="2180" />

## Props

| Name | Type | Default | Description |
| -------------------- | ------------------- | ------- | ----------------------------------------------------------------------------------------- |
| children <Required/> | `ReactNode[]` | - | Table of items to be displayed in the component's list. |
| separator | `boolean` | `true` | Enable or disable the display of the separator between items. |
| gap | `MantineNumberSize` | `"xl"` | Space between items. |
| stackProps | `stackProps` | - | Allows access to the props of the sub-component Stack. |
| ... | | - | Extends [ScrollArea props](https://v6.mantine.dev/core/scroll-area/?t=props) from Mantine |

0 comments on commit 0e332f7

Please sign in to comment.