Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/item list #16

Merged
5 commits merged into from
Feb 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/components/01-event-list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { GitHubLogo } from '../../src/icons/GitHubLogo';

# Event list

<Description
extendsInfo={[]}
importExample="import { EventList } 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/EventList/EventList.tsx',
}}
>
Simple item with a title, a color, a details section, and a description.
</Description>

## Storybook Docs

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

## Props

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