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

Storybook documentation/#110 #111

Merged
merged 28 commits into from
May 26, 2024
Merged

Storybook documentation/#110 #111

merged 28 commits into from
May 26, 2024

Conversation

gahyuun
Copy link
Member

@gahyuun gahyuun commented May 25, 2024

๐Ÿ“Œ ์ž‘์—… ๋‚ด์šฉ

close #110

๊ตฌํ˜„ ๋‚ด์šฉ ๋ฐ ์ž‘์—… ํ–ˆ๋˜ ๋‚ด์—ญ

  • view component ๋ฌธ์„œํ™”

๐Ÿค” ๊ณ ๋ฏผ ํ–ˆ๋˜ ๋ถ€๋ถ„

  • ์•„๋ž˜ ๊ตฌ์กฐ๋Œ€๋กœ ๋ฌธ์„œํ™”๋ฅผ ์ง„ํ–‰ํ–ˆ์Šต๋‹ˆ๋‹ค
const meta = {
  title: 'ui/view/', // ์Šคํ† ๋ฆฌ๋ถ ์ œ๋ชฉ ๋ฐ ์œ„์น˜ ์„ค์ •
  component:, // ์ปดํฌ๋„ŒํŠธ 
  tags: ['autodocs'], // documentation ์ƒ์„ฑ 
  parameters: {
    componentSubtitle:, // component์˜ ์„œ๋ธŒ ์ œ๋ชฉ์œผ๋กœ ๋„ค์ด๋ฐ๋งŒ ๋ดค์„ ๋•Œ ์—ญํ•  ์œ ์ถ”๊ฐ€ ์‰ฝ์ง€ ์•Š์€ ์ปดํฌ๋„ŒํŠธ๋“ค์—๋งŒ ์ถ”๊ฐ€๋ฅผ ํ–ˆ์Šต๋‹ˆ๋‹ค ( ex. label-container)
    description:{
     component:  // ๋ถ€๊ฐ€์ ์ธ ์„ค๋ช…์ด ํ•„์š”ํ•  ๋•Œ ์‚ฌ์šฉํ–ˆ์Šต๋‹ˆ๋‹ค. (ex molecule component์˜ ํ•˜์œ„ ์ปดํฌ๋„ŒํŠธ ์†Œ๊ฐœ )
   }
  },
  argTypes: {
    label: {
      description: // ๋งค๊ฐœ๋ณ€์ˆ˜๋“ค์˜ ์—ญํ• ์„ ๊ฐ„๋‹จํ•˜๊ฒŒ ์†Œ๊ฐœํ–ˆ์Šต๋‹ˆ๋‹ค 
    },
 variant: {
      description:,
      table: {
        type: { summary: 'ButtonVariant' },
        defaultValue: { summary: 'primary' },
      },
      options: ['primary', 'secondary', 'text', 'list', 'outlined'],
      control: {
        type: 'radio',
      }, // ๋ฒ„ํŠผ์˜ variant ์†์„ฑ์ฒ˜๋Ÿผ ์‚ฌ์šฉ์ž๊ฐ€ control ํ•˜๋ฉด์„œ UI๊ฐ€ ๋ฐ”๋€Œ๋Š” ๊ฑธ ํ™•์ธํ•˜๋ฉด ์ข‹์„ ๊ฒƒ ๊ฐ™์€ ์†์„ฑ๋“ค์€ control ํ•  ์ˆ˜ ์žˆ๊ฒŒ ๊ตฌํ˜„ํ–ˆ์Šต๋‹ˆ๋‹ค
    },
  },
} satisfies Meta<typeof >;

export default meta
  • ์œ„ ์†์„ฑ๋“ค์ด ๋ชจ๋‘ ์ ์šฉ๋œ๊ฒŒ grid story ์ž…๋‹ˆ๋‹ค ๋ชจ๋“  story๋ฅผ ํ™•์ธํ•˜๊ธฐ ์–ด๋ ต๋‹ค๋ฉด grid story๋ฅผ ๋ณด์‹œ๋ฉด ์ข‹์„ ๊ฒƒ ๊ฐ™๋„ค์š”!
  • shadcn ์ฝ”๋“œ๋กœ๋งŒ ๊ตฌ์„ฑ๋œ ์ปดํฌ๋„ŒํŠธ๋“ค์€ ( ex. sheet, alert, toast ๋“ฑ๋“ฑ.. ) ๋”ฐ๋กœ storybook์„ ๋งŒ๋“ค์ง€ ์•Š์•˜์Šต๋‹ˆ๋‹ค.

@gahyuun gahyuun self-assigned this May 25, 2024
@gahyuun gahyuun requested a review from yougyung as a code owner May 25, 2024 03:10
Copy link

Copy link
Member

@yougyung yougyung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

์ˆ˜๊ณ ํ•˜์…จ์Šต๋‹ˆ๋‹ค. ํ˜น์‹œ PR์„ ์ž‘์„ฑํ•˜๋ฉด์„œ ์ฐธ๊ณ ํ•œ ์ž๋ฃŒ๊ฐ€ ์žˆ๋‚˜์š”? ์žˆ๋‹ค๋ฉด ๊ณต์œ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค !

@gahyuun
Copy link
Member Author

gahyuun commented May 25, 2024

์ˆ˜๊ณ ํ•˜์…จ์Šต๋‹ˆ๋‹ค. ํ˜น์‹œ PR์„ ์ž‘์„ฑํ•˜๋ฉด์„œ ์ฐธ๊ณ ํ•œ ์ž๋ฃŒ๊ฐ€ ์žˆ๋‚˜์š”? ์žˆ๋‹ค๋ฉด ๊ณต์œ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค !

์ฐธ๊ณ ํ•œ ์ž๋ฃŒ๋Š” ์Šคํ† ๋ฆฌ๋ถ ๊ณต์‹ ๋ฌธ์„œ๋ž‘ ๊ณผ๊ฑฐ ์ œ ์ฝ”๋“œ ๋ฐ–์— ์—†์Šต๋‹ˆ๋‹ค..!

Copy link
Collaborator

@seonghunYang seonghunYang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • ์—„์ฒญ ๋งŽ๋„ค์š”. ์ •๋ง ์ˆ˜๊ณ  ๋งŽ์œผ์…จ์Šต๋‹ˆ๋‹ค. ๊ณ ๋ง™์Šต๋‹ˆ๋‹ค.

Comment on lines +22 to +25
table: {
type: { summary: 'GridCols' },
defaultValue: { summary: 3 },
},
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • ์š” table์ด๋ž€ ์†์„ฑ์€ ๋ญ”์ง€ ์„ค๋ช… ํ•ด์ฃผ์‹ค ์ˆ˜ ์žˆ์„๊นŒ์š”?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

table์ด ์–ด๋–ค ์—ญํ• ์„ ํ•˜๊ธฐ ๋ณด๋‹จ ๋‹จ์ˆœํžˆ ์ŠคํŽ™์ด์–ด์„œ defaultValue , control ๋“ฑ ์†์„ฑ์„ ์‚ฌ์šฉํ•˜๊ธฐ ์œ„ํ•ด์„œ table์„ ์ผ์Šต๋‹ˆ๋‹ค!

table?: {
      category?: string;
      defaultValue?: { summary: string; detail?: string };
      disable?: boolean;
      subcategory?: string;
      type?: { summary?: string; detail?: string };
    },

@gahyuun gahyuun merged commit 6c4fa7a into main May 26, 2024
3 checks passed
@gahyuun gahyuun deleted the storybook-documentation/#110 branch May 26, 2024 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

๊ณตํ†ต ์ปดํฌ๋„ŒํŠธ ์Šคํ† ๋ฆฌ๋ถ ๋ฌธ์„œํ™”
3 participants