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.

Sign up for GitHub

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

Jump to bottom

Docs: add docs for dropdown component #19 #42

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: add docs for dropdown component #19 #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
93 changes: 93 additions & 0 deletions src/components/Dropdown/Dropdown.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
import { Meta, Canvas, Story } from '@storybook/addon-docs';
import Dropdown from '.';
import { colorGuide } from '@primitives';

<Meta
title="Components/Dropdown"
component={Dropdown}
argTypes={{
colorConfig: {
border: {
control: { type: 'color' },
},
text: {
control: { type: 'color' },
},
chevron: {
control: { type: 'color' },
},
},
}}
/>

# Dropdown

Dropdown component is used when the users wants to select one or more items from a set of options.

## Usage

#### 1. Dropdown with label

export const DropdownWithLabel = (args) => {
return (
<Dropdown {...args} />
);
};

<Canvas>
<Story
name="Dropdown with label"
args={{
colorConfig: colorGuide.lightComponents.dropdown.withLabel,
label: 'Test'
}}
>
{DropdownWithLabel.bind()}
</Story>
</Canvas>

#### 2. Dropdown without label

export const DropdownWithoutLabel = (args) => {
return (
<Dropdown {...args} />
);
};

<Canvas>
<Story
name="Dropdown without label"
args={{
colorConfig: colorGuide.lightComponents.dropdown.withoutLabel,
}}
>
{DropdownWithoutLabel.bind()}
</Story>
</Canvas>

## Props

<div style={{overflowX: 'auto'}}>

| prop | description | type |
| -------------- | --------------------------------- | ---------- |
| `label` | label of dropdown | `string` |
| `colorConfig` | dropdown color config | `object` |
| `colorMode` | dark or light | `string` |
| `onClick` | onClick event handler | `function` |

</div>

**colorConfig**

colorConfig prop object support four color configurations namely: `border`, `text`, & `chevron`.

<div style={{overflowX: 'auto'}}>

| property | description | type |
| --------------- | ------------------------- | -------- |
| `border` | border color | `string` |
| `text` | text color | `string` |
| `chevron` | chevron color | `string` |

</div>
2 changes: 1 addition & 1 deletion src/components/Dropdown/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export interface DropdownConfig {
export type DropdownColorModes = 'dark' | 'light';
export interface DropdownProps {
onClick: () => void;
label: string;
label?: string;
colorConfig?: DropdownConfig;
colorMode?: DropdownColorModes;
}