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

Accordion 컴포넌트 스토리 작성 #24

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

YuHyun-P
Copy link
Member

@YuHyun-P YuHyun-P commented Jan 31, 2024

closed #11

✅ 작업 내용

  • Accordion 컴포넌트 스토리 작성
  • Accordion 컴포넌트 문서화

📌 이슈 사항

  • Accordion이 Accordion.Details, Accordion.Summary를 조합해서 사용하다보니 스토리를 작성하는게 조금 번거롭습니다.
    • autodocs 기능을 사용하면 Accordion 컴포넌트에 대한 메타 데이터만 문서화되서 Accordion.Summary 컴포넌트 props에 대한 설명을 일일이 작성해야 합니다.
    • Accordion / Accordion.Summary props에 대한 설명을 구분하기 위해 table.category 속성을 이용했습니다.
      image

✍ 궁금한 점

  • 스토리랑 props 설명이 충분한지 궁금합니다!

cf. [Storybook] 스토리북의 Docs 기능으로 컴포넌트 라이브러리 문서화하기 스토리북 설명이 잘 되어있어서 공유합니당

@YuHyun-P YuHyun-P self-assigned this Jan 31, 2024
Copy link

Chromatic Report

See Our Preivew ⚪️🔳🔲

open?: boolean;
children: ReactNode;
}

export default function Accordion({
Copy link
Member Author

@YuHyun-P YuHyun-P Jan 31, 2024

Choose a reason for hiding this comment

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

Accordion을 export default 한 후에 Details, Summary 속성을 추가하면 아래와 같이 스토리북 실행 도중 웹팩 컴파일 에러가 발생합니다. 정확한 이유는 못 찾았지만.. 속성 추가 코드와 export default 문 순서를 바꾸니 해결됐습니다😅

에러 메시지
accordion chunk load error

에러가 발생한 코드
스크린샷 2024-01-31 오후 5 10 58

@YuHyun-P YuHyun-P added the test 테스트 코드 추가 label Feb 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
test 테스트 코드 추가
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Accordion 컴포넌트 스토리 작성
1 participant