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

Docs: Created ArgTypes component and stories #20664

Merged
merged 10 commits into from
Jan 20, 2023

Conversation

tmeasday
Copy link
Member

@tmeasday tmeasday commented Jan 18, 2023

Issue: N/A

What I did

Created an ArgTypes block and stories to test it.

Questions:

  • Does this block need to support the components prop?
  • Does this block need to support the showComponent prop? If so, should it be a parameter (docs.argTypes.showComponent?)
  • Does this block need to show the component / subcomponents in a separate tab?
  • Does what this block does when you do of={meta} make sense?

How to test

See stories in chromatic / UI SB.

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

Does this block need to support the components prop?
Does this block need to support the showComponent prop? If so, should it be a parameter (docs.argTypes.showComponent?)

No, those are both undocumented features and we have discussed internally that we should just remove them entirely.

Does this block need to show the component / subcomponents in a separate tab?

Yes I would think so, we think people use that and we don't have an argument for removing it.

Does what this block does when you do of={meta} make sense?

It behaves as I would expect!

code/ui/blocks/src/blocks/ArgTypes.stories.tsx Outdated Show resolved Hide resolved
code/ui/blocks/src/blocks/ArgTypes.tsx Outdated Show resolved Hide resolved
@JReinhold JReinhold marked this pull request as draft January 18, 2023 07:48
@tmeasday tmeasday marked this pull request as ready for review January 19, 2023 04:08
@tmeasday
Copy link
Member Author

Ok, as discussed offline:

Does this block need to show the component / subcomponents in a separate tab?
Yes I would think so, we think people use that and we don't have an argument for removing it.

We are going to drop this concept for now (subcomponents). We are not going to show component props in the ArgTypes either (if passing of={story}).

Both will be supported until 8.0 in the legacy ArgsTable block. We will consider user feedback on whether we want to support them going forward in between now and then.

@tmeasday tmeasday mentioned this pull request Jan 19, 2023
5 tasks
Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

👍

code/ui/blocks/src/examples/ArgTypesParameters.stories.tsx Outdated Show resolved Hide resolved
@tmeasday tmeasday merged commit 00a64b4 into next Jan 20, 2023
@tmeasday tmeasday deleted the tom/sb-1149-implement-argtypes-block branch January 20, 2023 00:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants