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

Create storybook for TextInput, Card, Modal #1245

Open
wants to merge 7 commits into
base: dev
Choose a base branch
from

Conversation

ChaeyeonAhn
Copy link
Contributor

요약 *

It closes #1243

  • TextInput, Card, Modal의 스토리북 스토리를 만들었습니다.
  • web/packages.json에 storybook/preview-api를 추가했어요.
    TextInput 같이 상태 관리를 통해서 컴포넌트를 돌려봐야 하는 애들이 있어서 추가했습니다. useArgs를 쓰면 상태 관리가 가능하다고 하네요 !!!
  • 주석으로 달아둔 autodocs false를 default로 하는 건 어떠신지 궁금합니다 ㅎㅎ

스크린샷

autodocs 깨짐 예시

스크린샷 2024-12-04 오전 2 08 31

만든 스토리북 사용해보는 예시 영상

2024-12-04.2.08.55.mov

이후 Task *

  • 없음

@ChaeyeonAhn ChaeyeonAhn linked an issue Dec 3, 2024 that may be closed by this pull request
2 tasks
packages/web/src/stories/Modal.stories.tsx Outdated Show resolved Hide resolved
packages/web/.storybook/main.ts Outdated Show resolved Hide resolved
@jooyeongmee
Copy link
Contributor

image

요런식으로 mdx 파일 생성해서 기존의 autodocs를 덮어쓸 수도 있어~~
Canvas, Controls, Story 등 해서 각각 필요한 것만 넣어서 예제 작성할 수도 있고~
기본 적인 mdx 사용법이랑 똑같아서 주의사항이나 말로 설명 필요한거 넣을 수도 있고 코드 첨부할 수도 있어!
프론트 공통 문서에 정의된 유의사항 같은거나 속성같은거 좀 이해하기 애매한거 있으면 요런식으로 말로 적으면 도움될듯??

  • 예를 들어 TextInput에는 onChange도 있오 handleChange도 있어서 두개 각각 어떤 경우에 사용되는지 같은거?

해당 mdx로 실행하면 화면에서는 요렇게 나와
image
image

packages/web/src/stories/TextInput.stories.tsx Outdated Show resolved Hide resolved
packages/web/src/stories/Modal.stories.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

요거 스토리북 Primary 말고 하나 더 추가되면 좋을 거 같다!
PlayGround..? 이름 뭐라 해야 할지 모르겠는데 버튼 클릭하면 모달 열리고 확인 혹은 취소 누르면 모달 사라지는? 그런 동적인걸 확인 할 수 있게 하나 더 있으면 좋을거 같아!

그리고 CancellableModal 말고 ConfirmModal, ErrorModal, AgreeModal 도 있으면 좋을거 같오

Copy link
Contributor

Choose a reason for hiding this comment

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

시간 되면 예전에 프론트 문서에 요렇게 적었었는데 onClose 관련된 부분도 어디 설명이 되어 있으면 좋을 것 같아
image

@jooyeongmee
Copy link
Contributor

그러고보니 앞으로 스토리북 많이 만들텐데 스토리북 관련된 스니펫도 있으면 좋을거 같아...!!! 그치만 이것까진 바쁘면 그냥 나중에 내가 작업하게 될 때 슥 넣을게

@ChaeyeonAhn
Copy link
Contributor Author

2024-12-23.4.54.18.mov

모달 총 네 개를 만들었어요!
Cancellable, Agreement, Confirm, Error까지..!
얘네를 스토리북을 켜면 Modal 이라는 폴더로 묶이도록 해 보았는데, 다른 컴포넌트는 아예 이렇게 분류를 안 하구 얘네만 하는 게 좀 이상한 것 같긴 한데 한 번 봐주시면 좋을 것 같아요.

그리구 문제가 두 가지 있습니다.

  • errorModal은 오버레이를 쓰는 친구라서, errorModal 스토리를 켰다 끄더라도 다른 스토리에서 다 켜져 있어요. 이게 overlay 때문이라는데, 이걸 해결하려면 errorHandler 자체를 바꾸어야 하는 문제가 있어요.
  • AgreementModal의 chevron_right 얘가 스토리북 한 번 켜고 새로고침 해 줘야 제대로 렌더링 돼요..! docs에서 모달이 깨져보이는 걸 해결하려고 영미언니가 주신 코드를 넣어서 그 부분은 해결이 되었구, (감사합니다!) 해당 코드가 style을 추가로 지정해주는 것이다 보니 global style이 안 먹는 것 같아서 추가로 fontFamily로 material Icon 설정해주니까 렌더링이 되긴 되는데, 새로고침이 한 번 필요하다는 문제가 있어요.

@babycroc @jooyeongmee

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.

Create Story for TextInput, Card, Modal
3 participants