-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feat/ItemList
- Loading branch information
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | |