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

refactor: text field props #72

Merged
merged 3 commits into from
Apr 29, 2024
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { TextFieldProps } from '../TextField.type';

export interface PasswordTextFieldProps extends TextFieldProps {
export interface PasswordTextFieldProps extends Omit<TextFieldProps, 'suffix' | 'searchPrefix'> {
/** 입력된 내용을 보지 못하게 할 것인지 나타내는 속성 */
isMarked?: boolean;
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { useState } from 'react';

import { Stories, Primary as PrimaryBlock, Controls, Title } from '@storybook/blocks';
import { Meta, StoryObj } from '@storybook/react';

import { SimpleTextField } from './SimpleTextField';
Expand All @@ -10,58 +9,6 @@ const meta: Meta<typeof SimpleTextField> = {
component: SimpleTextField,
parameters: {
layout: 'centered',
docs: {
page: () => (
<>
<Title />
<PrimaryBlock />
<Controls />
<h2> 주의사항 </h2>
<ol>
<li>
TextField의 종류에 따라 suffix, searchPrefix 속성 값이 일부 정해져 있습니다.
<br />
<br />
<table>
<tr>
<th>종류</th>
<th>suffix</th>
<th>searchPrefix</th>
</tr>
<tr>
<td>SimpleTextField</td>
<td>IcXLine</td>
<td>설정 불가</td>
</tr>
<tr>
<td>SuffixTextField</td>
<td>사용자가 설정한 값</td>
<td>설정 불가</td>
</tr>
<tr>
<td>SearchTextField</td>
<td>IcXLine</td>
<td>IcSearchLine</td>
</tr>
<tr>
<td>PasswordTextField</td>
<td>IcEyeclosedLine 또는 IcEyeopenLine</td>
<td>설정 불가</td>
</tr>
</table>
</li>
<br />
<li>
boolean 타입 속성의 우선순위는 아래와 같습니다.
<br />
disabled &gt; isNegative &gt; isPositive
</li>
</ol>
<br />
<Stories />
</>
),
},
},
};
export default meta;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { TextFieldProps } from '../TextField.type';

export interface SimpleTextFieldProps extends TextFieldProps {
export interface SimpleTextFieldProps extends Omit<TextFieldProps, 'suffix' | 'searchPrefix'> {
/** x 버튼을 클릭했을 때 이벤트 핸들러 */
onClickClearButton?: () => void;
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ import { TextField } from '../TextField';

import { SuffixTextFieldProps } from './SuffixTextField.type';

export const SuffixTextField = ({ ...props }: SuffixTextFieldProps) => {
return <TextField suffix={props.suffix} {...props} />;
export const SuffixTextField = ({ suffix, ...props }: SuffixTextFieldProps) => {
return <TextField suffix={suffix} {...props} />;
};
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import { TextFieldProps } from '../TextField.type';

export interface SuffixTextFieldProps extends TextFieldProps {}
export interface SuffixTextFieldProps extends Omit<TextFieldProps, 'searchPrefix'> {
/** TextField 오른쪽에 들어갈 텍스트 */
suffix?: string;
}
72 changes: 72 additions & 0 deletions src/components/TextField/TextField.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
import { Controls, Title } from '@storybook/blocks';
import { Meta } from '@storybook/react';

import { TextField } from './TextField';

const meta: Meta = {
title: 'Atoms/TextField',
component: TextField,
parameters: {
layout: 'centered',
docs: {
page: () => (
<>
<Title />
<h2>주의사항</h2>
<ol>
<li>
TextField의 종류에 따라 suffix, searchPrefix 속성 값이 일부 정해져 있습니다.
<br />
<br />
<table>
<tbody>
<tr>
<th>종류</th>
<th>suffix</th>
<th>searchPrefix</th>
</tr>
<tr>
<td>SimpleTextField</td>
<td>IcXLine</td>
<td>설정 불가</td>
</tr>
<tr>
<td>SuffixTextField</td>
<td>사용자가 설정한 값</td>
<td>설정 불가</td>
</tr>
<tr>
<td>SearchTextField</td>
<td>IcXLine</td>
<td>IcSearchLine</td>
</tr>
<tr>
<td>PasswordTextField</td>
<td>IcEyeclosedLine 또는 IcEyeopenLine</td>
<td>설정 불가</td>
</tr>
</tbody>
</table>
</li>
<br />
<li>
boolean 타입 속성의 우선순위는 아래와 같습니다.
<br />
disabled &gt; isNegative &gt; isPositive
</li>
</ol>
<br />
<h2>TextField 속성</h2>
<Controls />
</>
),
},
},
};
export default meta;

const TextFieldStory = () => {};

export const Primary = {
render: TextFieldStory,
};
3 changes: 3 additions & 0 deletions src/components/TextField/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ export type { SimpleTextFieldProps } from './SimpleTextField/SimpleTextField.typ

export { SuffixTextField } from './SuffixTextField/SuffixTextField';
export type { SuffixTextFieldProps } from './SuffixTextField/SuffixTextField.type';

export { PasswordTextField } from './PasswordTextField/PasswordTextField';
export type { PasswordTextFieldProps } from './PasswordTextField/PasswordTextField.type';
3 changes: 3 additions & 0 deletions src/components/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@ export type { SimpleTextFieldProps } from './TextField';

export { SuffixTextField } from './TextField';
export type { SuffixTextFieldProps } from './TextField';

export { PasswordTextField } from './TextField';
export type { PasswordTextFieldProps } from './TextField';