Skip to content

Improve Storybook docs structure by hide or disable controls of internal-use Stories #1083

Open
@Dogdriip

Description

Description

Storybook MDX 문서 내부적으로 사용되는 Story가 Storybook 문서 구조(Sidebar 등)에 보이지 않아야 합니다.

Reasons for suggestion

image

image

  • MDX 문서에서 size나 color 등 여러 variant를 보여주고자 만들어 둔 Story가 있습니다.
  • 이 Story에는 하나의 컴포넌트가 여러 개 들어가 있어, Storybook의 Controls 등이 동작하지 않습니다.
    • image
  • 또한 MDX 문서 내에서 Docs 용도로만 사용되는 것을 의도했기에, 해당 Story를 Canvas view에서 단독으로 보거나 Controls를 조작하는 등의 behaviour는 의도하지 않은 유저 행동입니다.
  • 따라서 MDX 문서 내에서만 사용할 용도로 만든 Story는 Storybook 트리 구조에 노출되지 않아야 하고, 적어도 해당 Story는 동작하지 않고 단순히 Canvas view만을 위해 만들어진 Story라는 것을 명시해야 합니다.

Proposed solution

TODO

References

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    documentationIssue or PR that improvements or additions to documentationhelp wantedIssue or PR that extra attention is needed

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions